Search provider availability slots returning a list of ProviderSlot objects.

get

https://api.talkdeskapp.com/healthcare/available-provider-slots

Search provider available appointment slots returning a HalPaginatedResource

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

hls-provider:read

Query Params

provider_id

string

required

length between 0 and 1000

Healthcare provider identification

provider_ids

string

length between 1 and 2147483647

The id(s) of the providers, comma separated - GetOpenSlots2019.

service_type_id

string

required

length between 0 and 1000

Healthcare service type identification

location_id

string

required

length between 0 and 1000

Healthcare location identification

interaction_id

string

length ≥ 1

The ID of the interaction.

page

integer

1 to 50

Defaults to 1

The page number to request. Starts at 1, defaults to 1 when not provided.

per_page

integer

1 to 50

Defaults to 5

The maximum amount of items per page. Defaults to 5 when not provided.

count

integer

1 to 50

Defaults to 5

When per_page is too big, this count value will limit the number of slots returned on current page. The count value can't be bigger than per_page value.

start_date

date-time

length ≥ 1

The date from which the available slots should be considered as a viable option according to the client’s schedule. The default value is current date. If any preferred_ parameters is set, then the actual start_date will be set according to the preferred_ conditions.

end_date

date-time

length ≥ 1

The date until which the available slots should be considered as a viable option according to the client’s schedule. The default value is current date plus max_days value.

max_days

integer

1 to 2000

Defaults to 30

Quantity of days to look up in the future to fetch the appointments

timezone

string

Timezone from this interaction and must respect this format America/Chicago.

preferred_time

string

enum

length between 0 and 1000

Preferred slot time, if slot time meet this value, then the response field time_preferences_flag value value will be true.

Allowed:

preferred_week_day

string

enum

length between 0 and 1000

Preferred slot week day, if slot date meet this value, then the response field time_preferences_flag value value will be true.

Allowed:

preferred_month

string

enum

length between 0 and 1000

Preferred slot month, if slot date meet this value, then the response field time_preferences_flag value value will be true.

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

404Not Found

405Method Not Allowed

415Unsupported Media Type