ZOzocdoc
calendar-integration-timeslots

Get timeslots for provider on date

Get timeslots for a provider and date.

get/v1/providers/{provider_id}/calendar/timeslots

Request

  • Base URL
    https://api-developer-sandbox.zocdoc.com
  • Auth
    none declared

Path parameters

provider_idstring required
Example:pr_abc123-def456_wxyz7890

Query parameters

datestring date required
Example:2024-10-26

The date for which to get timeslots in YYYY-MM-DD format. This parameter will match against the local date part of the time slot's start_time. For example, a timeslot with start_time of 2024-10-01T22:00 and time_zone of America/New_York is considered 2024-10-01 when querying timeslots, even though it resolves to 2024-10-02 in UTC.

next_page_tokenstring

A token to get the next set of results.

limitinteger

The limit of objects to get in the response. For this endpoint, this is equivalent to page_size.

Response

OK

request_idstring required

Unique request identifier for tracing

limitinteger

Maximum number of items requested. Note: For DynamoDB-style pagination, this may not match the number of items returned.

next_page_tokenstring

Opaque cursor token for the next page. Null if no more pages.

next_urlstring

Complete URL for fetching the next page (convenience field)

Example response

{
  "data": [
    {
      "provider_id": "pr_abc123-def456_wxyz7890",
      "location_id": "lo_abc123-def456_wxyz7890",
      "start_time": "2024-09-03T09:30:00",
      "time_zone": "America/New_York",
      "allowed_visit_reason_ids": [
        "pc_FRO-18leckytNKtruw5dLR"
      ],
      "excluded_visit_reason_ids": [
        "pc_TlZW-r06U0W3pCsIGtSI5B"
      ],
      "patient_type": "new",
      "timeslot_id": "slot:ab123",
      "created_utc": "2024-01-01T09:30:00Z"
    }
  ]
}

Changes

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