Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
appointments
List appointments
curl --request GET \
  --url https://connect.voxys.ai/api/v1/accounts/{account_id}/appointments \
  --header 'api_access_token: <api-key>'
[
  {
    "id": 123,
    "contact_id": 123,
    "service_id": 123,
    "provider_id": 123,
    "appointment_at": "2023-11-07T05:31:56Z",
    "notes": "<string>",
    "cancellation_reason": "<string>",
    "conversation_id": 123,
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://developers.voxys.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api_access_token
string
header
required

All API requests must include the api_access_token header with a valid agent or administrator token.

Query Parameters

​
status
enum<string>
Available options:
pending,
confirmed,
completed,
cancelled,
rescheduled
​
provider_id
integer
​
service_id
integer
​
date
string<date>

Filter by specific date (YYYY-MM-DD)

​
start_date
string<date>

Range start date

​
end_date
string<date>

Range end date

Response

Appointments list

​
id
integer
​
contact_id
integer
​
service_id
integer
​
provider_id
integer
​
appointment_at
string<date-time>
​
status
enum<string>
Available options:
pending,
confirmed,
completed,
cancelled,
rescheduled
​
notes
string
​
cancellation_reason
string
​
conversation_id
integer
​
created_at
string<date-time>