Retrieve flat appointment scheduling

get

https://api.talkdeskapp.com/appointment-scheduling/virtual-agent/schedule-settings

Retrieve flat appointment scheduling by provider, service type or location.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

appointment-scheduling-va:read

Query Params

provider_id

string

length ≥ 1

Id of the provider.

service_type_id

string

length ≥ 1

Id of the service type.

location_id

string

length ≥ 1

Id of the location.

service_type_description

string

length ≥ 1

Service type description. Only applies if service_type_id is not specified.

provider_description

string

length ≥ 1

Provider description. Only applies if provider_id is not specified.

location_description

string

length ≥ 1

Location description. Only applies if location_id is not specified.

office_address

string

length ≥ 1

Office address. Only applies if location_id is not specified.

office_city

string

length ≥ 1

Office City. Only applies if location_id is not specified.

office_state

string

length ≥ 1

Office State. Only applies if location_id is not specified.

office_zip_code

string

length ≥ 1

Office zip code. Only applies if location_id is not specified.

office_phone_number

string

length ≥ 1

Office Phone Number. Only applies if location_id is not specified.

gender

string

length ≥ 1

The sex of the physician. Only applies if provider_id is not specified.

language

string

length ≥ 1

The language spoken by physician. Only applies if provider_id is not specified.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Scope

200OK

400Bad Request

401Unauthorized

403Forbidden