Search future appointments on VA returning a FutureAppointmentsVA object

get

https://api.talkdeskapp.com/healthcare/future-appointments-va

Search patients future appointments using interactionId returning one FutureAppointmentsVA object only. If the search finds multiple appointments a FutureAppointmentsVA object is returned with its total property pointing to the number of results found and the closest appointment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

hls-appointment:read

Query Params

interaction_id

string

required

length between 1 and 2147483647

Required interaction Id

count

integer

1 to 50

Defaults to 1

Number of appointments to fetch

start_date

date-time

length between 10 and 24

The date from which the available slots should be considered as a viable option according to the client’s schedule.

end_date

date-time

length between 10 and 24

The date until which the available slots should be considered as a viable option according to the client’s schedule.

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.

cancelable_only

boolean

Defaults to false

Return only appointments able to be cancelled

status

string

enum

length between 1 and 200

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

Scope

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

415Unsupported Media Type