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 schedulable-entities API

Endpoints to retrieve schedulable entities with availability information.

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

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

This API exposes 1 operation across 1 path, and defines 12 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.

1 operations 1 paths 12 schemas 1 GET

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 schedulable-entities 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 1

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

schedulable-entities 1

Endpoints to retrieve schedulable entities with availability information.

GET
/v1/schedulable_entities
Get schedulable entities
getSchedulableEntities 4 params → 200400401403

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are SchedulableEntity (8 properties), AvailabilityInfo (3 properties), RecentChangeSummary (3 properties), SchedulableEntitiesData (2 properties). Each schema is shown below with its type and property counts.

ErrorType
string
BaseResult
object
1 property 1 required
PaginatedBaseResult
SchedulableEntityType
string
RecentChangeSummary
object
3 properties 3 required
AvailabilityStatus
string
The availability status of the schedulable entity for the next 28 days. Limited availablility means that the entity has less than 20 timeslots available for th…
SchedulableEntitiesResponse
Error
object
2 properties 1 required
SchedulableEntitiesData
object
2 properties 2 required
ErrorResult
SchedulableEntity
object
8 properties 6 required
AvailabilityInfo
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zocdoc-schedulable-entities-api-openapi.yml Raw ↑

Other APIs Zocdoc publishes across the network.

Zocdoc appointments API
Zocdoc calendar-integration-timeslots API
Zocdoc credentials API
Zocdoc facilities API
Zocdoc insurance-reference API
Zocdoc provider-locations API
Zocdoc providers API
Zocdoc reference API
Zocdoc webhook API