List All Schedules

get

https://api.closurehealth.com/schedules

Returns a list of all practitioners associated with the requested index version.

Supports optional query parameters to filter down results.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

string

A comma-separated list of schedule ids to filter down to.

appointment_type_ids

string

A comma-separated list of appointment type ids (prefixed with aptp_) to filter down to.

location_ids

string

A comma-separated list of location ids (prefixed with loc_) to filter down to.

postal_code

string

Search for locations near a 5-digit postal code. Must be provided along with a radius.

radius

int32

Search for locations within a radius (in miles) around the provided postal code.

insurance_id

string

Search for schedules that accept an insurance id (prefixed with ins_).

practitioner_ids

string

A comma-separated list of practitioner ids (prefixed with prac_) to filter schedules down to.

type

string

enum

Search for schedules for a specific type of practitioner.

Allowed:

specialty_ids

string

A comma-separated list of specialty ids (prefixed with sp_) of the practitioners whose schedules to filter down to.

primary_specialty_id

string

The primary specialty id (prefixed with sp_) of the practitioners whose schedules to filter down to.

administrative_gender

string

enum

The administrative gender of the practitioners whose schedules to filter down to.

Allowed:

name

string

The name of practitioners whose schedules to filter down to. Performs a fuzzy match across first and last names.

Headers

Closure-API-Version

string

Defaults to 2022-04-01

Closure-Index-Version

string

Defaults to idx_standard

Response

Language

Credentials

Basic

base64

Loading…

Response

Choose an example:

application/json

200200