Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
A valid request URL is required to generate request examples{
"data": {
"id": "9a0f170e-0aa0-47db-ab14-4ddcdcbad061",
"reference": 123456789,
"appointment_at": "2021-01-01T00:00:00.000Z",
"duration_in_minutes": 60,
"is_interpreter_needed": true,
"interpreter_language": "English",
"status": "scheduled",
"url": "https://example.com/appointments/123456789",
"created_at": "2021-01-01T00:00:00.000Z",
"cancelled_at": "2021-01-01T00:00:00.000Z",
"cancellation_reason": "The appointment was cancelled because...",
"department": {
"id": 1,
"name": "Department"
},
"claimant": {
"name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"date_of_birth": "2023-12-25",
"data": [
{
"id": "<string>",
"value": "<string>",
"name": "<string>",
"type": "<string>",
"required": true
}
]
},
"meeting": {
"id": 1234567890,
"room_name": "Waiting Area 1",
"room_url": "https://meet.jit.si/WaitingArea1",
"start_date": "2021-01-30T08:30:00Z",
"end_date": "2021-01-30T09:30:00Z"
},
"session_started_at": "2021-01-01T00:00:00.000Z",
"session_ended_at": "2021-01-01T00:00:00.000Z",
"features_call_recording_enable": true,
"features_breakout_room_enable": true,
"features_webcam_access_agent_enable": true,
"features_webcam_access_claimant_enable": true,
"features_webcam_background_blurring_enable": true,
"features_microphone_access_enable": true,
"features_screen_sharing_enable": true,
"features_messages_chat_enable": true,
"features_participant_list_enable": true,
"features_bandwidth": "high",
"use_custom_post_call_redirect": true,
"custom_user_post_call_redirect_url": "https://example.com/custom-post-call-redirect",
"custom_agent_post_call_redirect_url": "https://example.com/custom-agent-post-call-redirect"
}
}Get a specific appointment by ID
A valid request URL is required to generate request examples{
"data": {
"id": "9a0f170e-0aa0-47db-ab14-4ddcdcbad061",
"reference": 123456789,
"appointment_at": "2021-01-01T00:00:00.000Z",
"duration_in_minutes": 60,
"is_interpreter_needed": true,
"interpreter_language": "English",
"status": "scheduled",
"url": "https://example.com/appointments/123456789",
"created_at": "2021-01-01T00:00:00.000Z",
"cancelled_at": "2021-01-01T00:00:00.000Z",
"cancellation_reason": "The appointment was cancelled because...",
"department": {
"id": 1,
"name": "Department"
},
"claimant": {
"name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"date_of_birth": "2023-12-25",
"data": [
{
"id": "<string>",
"value": "<string>",
"name": "<string>",
"type": "<string>",
"required": true
}
]
},
"meeting": {
"id": 1234567890,
"room_name": "Waiting Area 1",
"room_url": "https://meet.jit.si/WaitingArea1",
"start_date": "2021-01-30T08:30:00Z",
"end_date": "2021-01-30T09:30:00Z"
},
"session_started_at": "2021-01-01T00:00:00.000Z",
"session_ended_at": "2021-01-01T00:00:00.000Z",
"features_call_recording_enable": true,
"features_breakout_room_enable": true,
"features_webcam_access_agent_enable": true,
"features_webcam_access_claimant_enable": true,
"features_webcam_background_blurring_enable": true,
"features_microphone_access_enable": true,
"features_screen_sharing_enable": true,
"features_messages_chat_enable": true,
"features_participant_list_enable": true,
"features_bandwidth": "high",
"use_custom_post_call_redirect": true,
"custom_user_post_call_redirect_url": "https://example.com/custom-post-call-redirect",
"custom_agent_post_call_redirect_url": "https://example.com/custom-agent-post-call-redirect"
}
}Provide a Bearer Token
The Uuid of the required appointment model Resource identifier as a UUID
"9a0f170e-0aa0-47db-ab14-4ddcdcbad061"
The request has succeeded.
Show child attributes
