Endpoints to retrieve information about the developer's directory.
API Documentation (1.22)
Download OpenAPI description
Languages
Servers
Sandbox
https://api-developer-sandbox.zocdoc.com/
Production
https://api-developer.zocdoc.com/
Query
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.
Example: date=2024-10-26
The limit of objects to get in the response. For this endpoint, this is equivalent to page_size.
Default 500
- Sandbox
https://api-developer-sandbox.zocdoc.com/v1/providers/{provider_id}/calendar/timeslots
- Production
https://api-developer.zocdoc.com/v1/providers/{provider_id}/calendar/timeslots
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-developer-sandbox.zocdoc.com/v1/providers/pr_abc123-def456_wxyz7890/calendar/timeslots?date=2024-10-26&limit=500&next_page_token=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Request
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. A new request is made for the same provider and date will overwrite the previous set of slots. If you send an empty request body, all slots for that provider on that date will be deleted.
Note: The timeslots are stored in an eventually consistent data store. This means there is a small possibility that a fetch might not include recently created slots if you fetch timeslots immediately after inserting them.
Parameter Validations:
- The user must have access to the specified
provider_id.
Validations for each timeslot in the request body:
slot.provider_id:- Must match the
provider_idspecified in the endpoint parameter.
- Must match the
slot.start_time:- Must be a valid "local date-time" string in ISO 8601 format, e.g.,
2024-09-15T12:13:00. The seconds component is optional. - The date component must match the
dateparameter.
- Must be a valid "local date-time" string in ISO 8601 format, e.g.,
slot.time_zone:- Must be a valid IANA time zone ID (e.g.,
America/New_YorkorAmerica/Denver).
- Must be a valid IANA time zone ID (e.g.,
Security
ClientCredentialsFlow
- Sandbox
https://api-developer-sandbox.zocdoc.com/v1/providers/{provider_id}/calendar/timeslots
- Production
https://api-developer.zocdoc.com/v1/providers/{provider_id}/calendar/timeslots
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api-developer-sandbox.zocdoc.com/v1/providers/pr_abc123-def456_wxyz7890/calendar/timeslots?date=2024-10-16' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"timeslots": [
{
"provider_id": "pr_abc123-def456_wxyz7890",
"location_id": "lo_abc123-def456_wxyz7890",
"start_time": "2024-10-16T09:30:00",
"time_zone": "America/New_York",
"allowed_visit_reason_ids": [
"pc_TlZW-r06U0W3pCsIGtSI5B"
],
"excluded_visit_reason_ids": [
"pc_TAZW-r16U0B3pZeIutSI3L"
],
"patient_type": "new"
}
]
}'