{"items":[{"type":"link","label":"API Documentation","link":"/apis","routeSlug":"/apis"},{"type":"group","label":"NPIs","link":"/apis/reference","routeSlug":"/apis/reference","items":[{"label":"Get active provider NPIs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/reference/getprovidernpis","routeSlug":"/apis/reference/getprovidernpis","metadata":{"seo":{"title":"Get active provider NPIs","description":"Retrieves the list of active provider NPIs within the developer's Zocdoc directory. The NPIs retrieved here can be used to search for providers in the /v1/providers endpoint to facilitate availability, discovery, and booking."}},"httpPath":"/v1/reference/npi"}]},{"type":"group","label":"Directory Management","link":"/apis/schedulable-entities","routeSlug":"/apis/schedulable-entities","items":[{"label":"Get schedulable entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/schedulable-entities/getschedulableentities","routeSlug":"/apis/schedulable-entities/getschedulableentities","metadata":{"seo":{"title":"Get schedulable entities","description":"Get the list of schedulable entities within the developer's Zocdoc directory (provider-locations, etc.) with availability information."}},"httpPath":"/v1/schedulable_entities"},{"label":"Submit NPI overlaps","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/schedulable-entities/putschedulableentitiesoverlaps","routeSlug":"/apis/schedulable-entities/putschedulableentitiesoverlaps","metadata":{"seo":{"title":"Submit NPI overlaps","description":"Submit NPI overlaps to compare your provider directory with providersbookable on Zocdoc. Send real-time distribution status(developer_app_state), unverified addresses and other data requiredfor joint provider operations."}},"httpPath":"/v1/schedulable_entities/overlaps"}]},{"type":"group","label":"Insurance","link":"/apis/insurance-reference","routeSlug":"/apis/insurance-reference","items":[{"label":"Get insurance plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/insurance-reference/getinsuranceplans","routeSlug":"/apis/insurance-reference/getinsuranceplans","metadata":{"seo":{"title":"Get insurance plans","description":"Get insurance plans"}},"httpPath":"/v1/insurance_plans"},{"label":"Get insurance plan by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/insurance-reference/getinsuranceplan","routeSlug":"/apis/insurance-reference/getinsuranceplan","metadata":{"seo":{"title":"Get insurance plan by id","description":"Get insurance plan by id."}},"httpPath":"/v1/insurance_plans/{insurance_plan_id}"}]},{"type":"group","label":"Providers","link":"/apis/providers","routeSlug":"/apis/providers","items":[{"label":"Get providers by NPIs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/providers/getproviders","routeSlug":"/apis/providers/getproviders","metadata":{"seo":{"title":"Get providers by NPIs","description":"Retrieves specific providers within the developer's directory by NPI search. This endpoint searches active providers that are listed on Zocdoc. It returns the provider's information (such as name, gender identity, specialty), location information and provider location IDs which can be used to look up availability and book appointments. Every developer has a designated provider directory jointly defined and onboarded in partnership with Zocdoc."}},"httpPath":"/v1/providers"}]},{"type":"group","label":"Provider locations","link":"/apis/provider-locations","routeSlug":"/apis/provider-locations","items":[{"label":"Get provider locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider-locations/getproviderlocations","routeSlug":"/apis/provider-locations/getproviderlocations","metadata":{"seo":{"title":"Get provider locations","description":"This endpoint accepts parameters such as zip code, specialty, visit reason and accepted insurance to return a filtered set of providers within the developer's directory. The response includes additional information about the provider location objects returned."}},"httpPath":"/v1/provider_locations"},{"label":"Get provider location by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider-locations/getproviderlocation","routeSlug":"/apis/provider-locations/getproviderlocation","metadata":{"seo":{"title":"Get provider location by id","description":"Get info about a provider location by provider_location_id"}},"httpPath":"/v1/provider_locations/{provider_location_id}"},{"label":"Get availability for provider locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider-locations/getproviderlocationsavailability","routeSlug":"/apis/provider-locations/getproviderlocationsavailability","metadata":{"seo":{"title":"Get availability for provider locations","description":"Retrieves availability for a set of provider locations. Required parameters passed include provider location ids, visit reason id and patient type. Visit reason and patient type (new or existing) are used to calculate the duration of the appointment and break availability into bookable timeslots based on the appointment duration. The response output includes the start times of appointments based on these calculations."}},"httpPath":"/v1/provider_locations/availability"},{"label":"Get insurance mappings for provider location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider-locations/getproviderlocationinsurancemappings","routeSlug":"/apis/provider-locations/getproviderlocationinsurancemappings","metadata":{"seo":{"title":"Get insurance mappings for provider location","description":"Get eligible insurance plans and insurance mappings for a provider location by provider_location_id"}},"httpPath":"/v1/provider_locations/{provider_location_id}/insurance_mappings"},{"label":"Submit request to update mapped insurance plans","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider-locations/updateproviderlocationinsurancemappings","routeSlug":"/apis/provider-locations/updateproviderlocationinsurancemappings","metadata":{"seo":{"title":"Submit request to update mapped insurance plans","description":"Submits a request to update mapped insurance plans. This is an asynchronous operation and the response indicates the request was accepted for processing, not that the update is complete."}},"httpPath":"/v1/provider_locations/{provider_location_id}/insurance_mappings"}]},{"type":"group","label":"Reviews","link":"/apis/reviews","routeSlug":"/apis/reviews","items":[{"label":"Get reviews for a single provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/reviews/getproviderreviews","routeSlug":"/apis/reviews/getproviderreviews","metadata":{"seo":{"title":"Get reviews for a single provider","description":"Get review summary for a provider by their Zocdoc provider ID."}},"httpPath":"/v1/providers/{provider_id}/reviews"},{"label":"Get reviews for providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/reviews/getproviderreviewsbatch","routeSlug":"/apis/reviews/getproviderreviewsbatch","metadata":{"seo":{"title":"Get reviews for providers","description":"Get review summaries for up to 100 providers in a single call, by their Zocdoc provider IDs. Duplicate IDs are collapsed; returns one item per distinct requested ID, in request order. Providers that are unknown or not accessible to the caller are returned with zero/null ratings."}},"httpPath":"/v1/providers/reviews"}]},{"type":"group","label":"Facilities","link":"/apis/facilities","routeSlug":"/apis/facilities","items":[{"label":"Get facilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/facilities/getfacilities","routeSlug":"/apis/facilities/getfacilities","metadata":{"seo":{"title":"Get facilities","description":"Get a set of facilities within the developer's network."}},"httpPath":"/v1-beta/facilities"},{"label":"Get facility by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/facilities/getfacility","routeSlug":"/apis/facilities/getfacility","metadata":{"seo":{"title":"Get facility by id","description":"Get facility by facility id."}},"httpPath":"/v1-beta/facilities/{facility_id}"}]},{"type":"group","label":"Calendar integration timeslots","link":"/apis/calendar-integration-timeslots","routeSlug":"/apis/calendar-integration-timeslots","items":[{"label":"Get timeslots for provider on date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/calendar-integration-timeslots/getprovidercalendartimeslots","routeSlug":"/apis/calendar-integration-timeslots/getprovidercalendartimeslots","metadata":{"seo":{"title":"Get timeslots for provider on date","description":"Get timeslots for a provider and date."}},"httpPath":"/v1/providers/{provider_id}/calendar/timeslots"},{"label":"Put provider calendar timeslots","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/calendar-integration-timeslots/putprovidercalendartimeslots","routeSlug":"/apis/calendar-integration-timeslots/putprovidercalendartimeslots","metadata":{"seo":{"title":"Put provider calendar timeslots","description":"This endpoint sets the complete list of available slots for a specific provider on a specific date. Each request must include the entire set of slots for that date. If a provider wishes to list times at multiple locations for a single date, each location must have its own timeslot object added to the array. A new request made for the same provider and date will overwrite the previous set of slots. If you send an empty array, all slots for that provider across all locations on that date will be deleted."}},"httpPath":"/v1/providers/{provider_id}/calendar/timeslots"}]},{"type":"group","label":"Appointments","link":"/apis/appointments","routeSlug":"/apis/appointments","items":[{"label":"Create appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/createappointment","routeSlug":"/apis/appointments/createappointment","metadata":{"seo":{"title":"Create appointment","description":"This endpoint is used for creating new appointments. Developers should gather the necessary information to pass in the request body as inputs for this endpoint. Only timeslots retrieved from the /v1/provider_locations/availability endpoint will be accepted. After an /appointments call is successfully processed, the system will return an appointment ID."}},"httpPath":"/v1/appointments"},{"label":"Get appointments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/getappointments","routeSlug":"/apis/appointments/getappointments","metadata":{"seo":{"title":"Get appointments","description":"This endpoint retrieves the paginated list of appointment details and statuses for the given credential. By default, appointments will be returned in descending order of start time."}},"httpPath":"/v1/appointments"},{"label":"Get appointment by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/getappointment","routeSlug":"/apis/appointments/getappointment","metadata":{"seo":{"title":"Get appointment by id","description":"This endpoint retrieves updated appointment details and the status of a single existing appointment. Developers must send a valid appointment_id as input in the request body, and Zocdoc returns the appointment details and status for that appointment. See Appointment Status definitions."}},"httpPath":"/v1/appointments/{appointment_id}"},{"label":"Get participants for appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/getappointmentparticipants","routeSlug":"/apis/appointments/getappointmentparticipants","metadata":{"seo":{"title":"Get participants for appointment","description":"This endpoint retrieves the participants of an appointment. Developers must provide a valid appointment_id as a path parameter, and Zocdoc returns the participants of that appointment."}},"httpPath":"/v1/appointments/{appointment_id}/participants"},{"label":"Cancel appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/cancelappointment","routeSlug":"/apis/appointments/cancelappointment","metadata":{"seo":{"title":"Cancel appointment","description":"This endpoint is used to request the cancellation of an appointment in a non-cancelled status. (Non-cancelled statuses include: pending_booking, booking_failed, confirmed, pending_reschedule, reschedule_failed and rescheduled)"}},"httpPath":"/v1/appointments/cancel"},{"label":"Confirm appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/confirmappointment","routeSlug":"/apis/appointments/confirmappointment","metadata":{"seo":{"title":"Confirm appointment","description":"This endpoint is used to confirm an appointment in pending booking status. Developers must send a valid appointment_id as input in the request body."}},"httpPath":"/v1/appointments/confirm"},{"label":"Reschedule appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/rescheduleappointment","routeSlug":"/apis/appointments/rescheduleappointment","metadata":{"seo":{"title":"Reschedule appointment","description":"This endpoint is used to only modify the appointment time and request the reschedule of an appointment in pending_booking, confirmed, pending_reschedule, or rescheduled status. Developers must send a valid appointment_id and a new start time as input in the request body."}},"httpPath":"/v1/appointments/reschedule"},{"label":"Create attachment for appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/uploadappointmentattachment","routeSlug":"/apis/appointments/uploadappointmentattachment","metadata":{"seo":{"title":"Create attachment for appointment","description":"This endpoint is used to upload attachment documents related to the appointment for the provider to view. You can upload more than one attachment with the same attachment_type for the same appointment_id if needed. The provider will be able to receive all uploaded attachments."}},"httpPath":"/v1/appointments/{appointment_id}/attachments"},{"label":"Update appointment status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/updateappointmentstatus","routeSlug":"/apis/appointments/updateappointmentstatus","metadata":{"seo":{"title":"Update appointment status","description":"Use this endpoint to update the status of an appointment to either 'arrived' or 'no_show'."}},"httpPath":"/v1/appointments/update-status"}]},{"type":"group","label":"Webhook","link":"/apis/webhook","routeSlug":"/apis/webhook","items":[{"label":"Mock webhook request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/webhook/mockwebhookrequest","routeSlug":"/apis/webhook/mockwebhookrequest","metadata":{"seo":{"title":"Mock webhook request","description":"Mock webhook request"}},"httpPath":"/v1/webhook/mock-request"}]},{"type":"group","label":"Specialties","link":"/apis/specialties","routeSlug":"/apis/specialties","items":[{"label":"Get specialties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/specialties/getspecialties","routeSlug":"/apis/specialties/getspecialties","metadata":{"seo":{"title":"Get specialties","description":"Get specialties with optional filtering by care category"}},"httpPath":"/v1/specialties"},{"label":"Get specialty by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/specialties/getspecialtybyid","routeSlug":"/apis/specialties/getspecialtybyid","metadata":{"seo":{"title":"Get specialty by id","description":"Get specialty by id"}},"httpPath":"/v1/specialties/{specialty_id}"}]},{"type":"group","label":"Visit Reasons","link":"/apis/visit-reasons","routeSlug":"/apis/visit-reasons","items":[{"label":"Get visit reasons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/visit-reasons/getvisitreasons","routeSlug":"/apis/visit-reasons/getvisitreasons","metadata":{"seo":{"title":"Get visit reasons","description":"Get visit reasons with optional filtering by specialty"}},"httpPath":"/v1/visit_reasons"},{"label":"Get visit reason by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/visit-reasons/getvisitreasonbyid","routeSlug":"/apis/visit-reasons/getvisitreasonbyid","metadata":{"seo":{"title":"Get visit reason by id","description":"Get visit reason by id"}},"httpPath":"/v1/visit_reasons/{visit_reason_id}"}]}]}