Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zocdoc calendar-integration-timeslots API

Endpoints to manage timeslots for providers.

Zocdoc calendar-integration-timeslots API is one of 10 APIs that Zocdoc publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include calendar-integration-timeslots. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a changelog.

This API exposes 2 operations across 1 path, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 1.176.

Requests are made against 2 base URLs: https://api-developer-sandbox.zocdoc.com, https://api-developer.zocdoc.com.

2 operations 1 paths 9 schemas 1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.176
Base URL
https://api-developer.zocdoc.com
Authentication
OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Zocdoc calendar-integration-timeslots API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (ClientCredentialsFlow) using the clientCredentials flow, exposing 6 scopes. It supports OAuth 2.0 (AuthorizationCodeFlow) using the authorizationCode flow, exposing 3 scopes.

  • ClientCredentialsFlow — Machine to machine authentication (for use from client server to Zocdoc). Production: https://auth.zocdoc.com/oauth/token Sandbox: https://auth-api-developer-s…
  • AuthorizationCodeFlow — Log in as a user. Client Secret is not necessary for this login flow. Production: https://auth.zocdoc.com Sandbox: https://auth-api-developer-sandbox.zocdoc.com

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

calendar-integration-timeslots 2

Endpoints to manage timeslots for providers.

GET
/v1/providers/{provider_id}/calendar/timeslots
Get timeslots for provider on date
getProviderCalendarTimeslots 4 params → 200400401403
PUT
/v1/providers/{provider_id}/calendar/timeslots
Put provider calendar timeslots
putProviderCalendarTimeslots 2 params body → 200400401403

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are CalendarIntegrationTimeslotWeb (9 properties), TimeslotBaseRequest (7 properties), TimeslotPutResponse (1 property), BaseResult (1 property). Each schema is shown below with its type and property counts.

CalendarIntegrationTimeslotWeb
object
A bookable appointment start time for a particular provider
9 properties 2 required
BaseResult
object
1 property 1 required
TimeslotPutResponse
object
1 property
TimeslotPutErrors
object
1 property 1 required
TimeslotPutRequest
object
1 property 1 required
TimeslotBaseRequest
object
a bookable appointment start time for a particular provider
7 properties 4 required
PatientType
string
Whether or not the patient has been to the provider's practice.
IteratedBaseResult
TimeslotListResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zocdoc-calendar-integration-timeslots-api-openapi.yml Raw ↑

Other APIs Zocdoc publishes across the network.

Zocdoc appointments API
Zocdoc credentials API
Zocdoc facilities API
Zocdoc insurance-reference API
Zocdoc provider-locations API
Zocdoc providers API
Zocdoc reference API
Zocdoc schedulable-entities API
Zocdoc webhook API