ZOzocdoc
schedulable-entities

Get schedulable entities

Get the list of schedulable entities within the developer's Zocdoc directory (provider-locations, etc.) with availability information.

NPIs can be used to search for providers in the /v1/providers endpoint to facilitate availability, discovery, and booking. Schedulable entity ids can be used to find provider-locations in the /v1/provider_locations/{provider_location_id} endpoint to facilitate availability, discovery, and booking.

Developers can fetch the schedulable entities list and cache in their system. The available schedulable entities do not change frequently. Pulling this data once a week and/or after known directory change events should be sufficient. However, you may use the recent_changes_72hrs parameter and the recent_change_summary field to get the list of entities that have changed in the last 72 hours.

get/v1/schedulable_entities

Request

  • Base URL
    https://api-developer-sandbox.zocdoc.com
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://auth.zocdoc.com/oauth/token scopes: external.schedulable_entity.read
    • or OAuth 2
      Authorization code: https://auth.zocdoc.com/authorize
      Token URL: https://auth.zocdoc.com/oauth/token scopes: external.schedulable_entity.read

Query parameters

pageinteger

The zero indexed page of results. A mimimum value of 0 will be accepted.

page_sizeinteger

The number of results to return per page. The default value is 5000. A mimimum value of 1 and a maximum of 10000 will be accepted.

schedule_typesstring

The comma-delimited list of schedule types to include. Will return all schedule types if not provided.

recent_changes_72hrsboolean

When true, only includes entities added or updated in the last 72 hours

Response

Success

request_idstring required

Unique request identifier for tracing

pageinteger required

The zero based index of the current page.

page_sizeinteger required

The size of the current page.

total_countinteger required

The total number of result items.

next_urlstring required

A link to the next page of results; null if this is the last page of results.

Example response

{
  "data": {
    "schedulable_entities": [
      {
        "time_zone": "America/New_York",
        "main_specialty_id": "sp_123",
        "main_specialty_name": "Cardiologist",
        "practice_id": "pt_abc123"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.