Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

• New phone_number and phone_extension fields on the location object, returned on endpoints that include location data. Note: phone_number returns null for certain API products.
• New time_zone field (IANA format, e.g., America/New_York) on location and availability objects, returned on provider location, availability, and related endpoints
• New Reference Data endpoints to retrieve specialties and visit reasons programmatically: Get Specialties (/v1/specialties), Get Specialty by ID (/v1/specialties/{specialty_id}), Get Visit Reasons (/v1/visit_reasons), and Get Visit Reason by ID (/v1/visit_reasons/{visit_reason_id})
• New latitude and longitude query parameters on the Get Providers endpoint. When both are provided, each physical location includes a distance value and an is_nearest_match flag identifying the closest location to the patient.
• New Reference Data section in the documentation, grouping the specialties and visit reasons endpoints

• The notes field on appointment objects now enforces a 100-character maximum limit
• The page_size parameter on the schedulable entities endpoint now defaults to 5,000 (previously 60,000) with a maximum of 10,000 (previously 60,000)
• Updated the Reference Data guide to direct developers to the new specialties and visit reasons endpoints instead of contacting support

• New provider_id field on the base provider object, returned on all endpoints that return provider data
• New source field on the appointment object indicating the channel where the appointment was booked (e.g., "Zocdoc Marketplace", "Your website")
• New attachment types patient_front_insurance_card and patient_back_insurance_card for the Upload Appointment Attachment endpoint
• New insurance plan types: hmo_pos, medicare_advantage, medicaid_managed_care, and federal
• The PUT timeslots endpoint now returns a response body with error details when location IDs are not found

• Increased attachment upload size limit from 10MB to 100MB
• The page_size parameter on the timeslots endpoint now enforces a range of 1–10,000
• Simplified credential access documentation in the cancel and reschedule appointment guides
• Fixed operationId for the credential rotation endpoint (rotateCredential → rotateCredentials)

• New Provider Reviews endpoint (/v1/providers/{provider_id}/reviews) to retrieve review summary for a provider. Note: requires the appropriate scope enabled for your API client.
• Security requirement and OAuth scope for credential rotation endpoint (/v1/credentials/rotate)

• Clarified webhook behavior for patient booking use case: notifications are only sent for provider-initiated appointment changes
• Updated insurance plan documentation to reference the Get Insurance Plans endpoint for retrieving plan IDs programmatically
• Fixed API server URLs to display the correct public endpoints (sandbox and production)

• Guides and references fixes and additions based off of feedback

• New field profile_url added to provider object. Returned on endpoints that return provider information.

• Guides fixes and additions based off of feedback
• Backend changes to improve our API's reliability and performance

• Documentation fixes and additions based off of feedback

• New fields insurance_carrier_id, insurance_plan_id and published_context to v1/provider_locations/availability endpoint for syndication use cases.

• Documentation fixes and additions based off of feedback
• Backend changes to improve our API's reliability and performance

• Documentation fixes and additions based off of feedback
• Backend changes to improve our API's reliability and performance

• Full launch of v1/schedulable_entities endpoint.
• Schedulable Entities Feed guide added into guides section.

• Documentation improvements based off of feedback

• Support of gzip compression on both the request and response body.
• New field booking_url to Timeslot object.
• FAQ Section to documentation.

• Expanded availability max range to 31 days
• Documentation improvements based off of feedback