GuidesAPI EndpointsKnowledge BaseSupportTalkdesk WebsiteMarketplaceDiscussions API Change LogOpenAPI Specification Download
API Endpoints
Home
  1. Public API
  2. HLS Providers

Get future appointments

get
https://api.talkdeskapp.com/healthcare/appointments

Get a list of future appointments connected via an interactionId.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

hls-appointment:read

Query Params
string
required
length between 1 and 2147483647

Interaction ID

date-time
length between 10 and 24

The initial date from which the appointments should retrieved

date-time
length between 10 and 24

The final date up until which the appointments should retrieved

integer
1 to 2000
Defaults to 30

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

string

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

boolean

Boolean to fetch only future appointments that are cancelable

string
enum
length between 1 and 200

List of the desired appointment statuses, comma-separated (e.g. 'booked,noshow')

string
enum

Appointment category

Allowed:
boolean
Defaults to false

When true, each appointment may carry an optional location_details block with the image and/or the phone numbers of its location, as resolved from the Locations directory. The block is omitted when the location cannot be resolved or has neither. Defaults to false, in which case the Locations directory is not queried.

integer
1 to 2147483647
Defaults to 1
integer
1 to 50
Defaults to 5
Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?