ZOzocdoc
appointments

Get appointments

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.

A maximum of 1,000 total appointments will be returned via pagination; if more are expected, use filters and batch requests.

If the request comes from a Zocdoc user credential, only appointments that user has created will be returned. If the request comes from a machine-to-machine credential, any appointments that were booked with that developer will be returned.

get/v1/appointments

Request

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

Query parameters

pageinteger

The zero indexed page of results. A mimimum value of 0 and a maximum of 10 will be accepted.

page_sizeinteger

The number of results to return per page. A mimimum value of 1 and a maximum of 100 will be accepted.

statusesstring
Example:pending_booking,confirmed

A comma-delimited list of Zocodc appointment statuses to filter appointments by.

developer_patient_idstring

The patient identifier provided by 3P developer to filter appointments by.

sort_by'start_time_utc' | 'created_time_utc' | 'last_modified_time_utc'

Field to sort appointments by:

  • start_time_utc - Sort by appointment start time (default)
  • created_time_utc - Sort by when appointment was created
  • last_modified_time_utc - Sort by when appointment was last modified

The field to sort appointments by. Default is start_time.

sort_direction'ascending' | 'descending'

The direction to sort appointments by. Default is descending.

practice_idsstring
Example:pt_abc123-def456_wxyz7890,pt_ghi123-jkl456_mnop7890

The comma separated values of practice ids to filter appointments by

provider_idsstring
Example:pr_abc123-def456_wxyz7890,pr_ghi123-jkl456_mnop7890

The comma separated values of provider ids to filter appointments by

location_idsstring
Example:lo_abc123-def456_wxyz7890,lo_ghi123-jkl456_mnop7890

The comma separated values of location ids to filter appointments by

start_time_utc_minstring instant
Example:2024-01-01 00:00:00+00:00

The minimum UTC start time of the appointments to fetch. Exclude appointments that start before this time.

start_time_utc_maxstring instant
Example:2024-01-01 00:00:00+00:00

The maximum UTC start time of the appointments to fetch. Exclude appointments that start after this time.

created_time_utc_minstring instant
Example:2024-01-01 00:00:00+00:00

The minimum UTC created time of the appointments to fetch. Exclude appointments that were created before this time.

created_time_utc_maxstring instant
Example:2024-01-01 00:00:00+00:00

The maximum UTC created time of the appointments to fetch. Exclude appointments that were created after this time.

last_modified_time_utc_minstring instant
Example:2024-01-01 00:00:00+00:00

The minimum UTC last modified time of the appointments to fetch. Exclude appointments that were last modified before this time.

last_modified_time_utc_maxstring instant
Example:2024-01-01 00:00:00+00:00

The maximum UTC last modified time of the appointments to fetch. Exclude appointments that were last modified after this time.

Response

Successful

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": [
    {
      "location_phone_number": "9999999999",
      "start_time": "2022-04-27T09:00:00-04:00",
      "created_time_utc": "2024-01-01T09:30:00Z",
      "last_modified_time_utc": "2024-01-01T09:30:00Z",
      "patient_type": "new"
    }
  ]
}

Changes

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