Skip to main content
GET
/
api
/
v1
/
appointments
/
{id}
Get an appointment by id
curl --request GET \
  --url https://app.vorel.ai/api/v1/appointments/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_name": "<string>",
  "customer_phone": "<string>",
  "scheduled_start": "2023-11-07T05:31:56Z",
  "scheduled_end": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "offering_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_email": "jsmith@example.com",
  "location_text": "<string>",
  "google_calendar_event_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Tenant-issued API key. Format: vapk_live_<48 hex chars> (60 chars total). Issue + manage at /settings/integrations/api-keys in the Vorel dashboard. Each key has a scope set (read, leads:write, appointments:write, offerings:write); endpoints requiring a write scope reject keys without it with a 403 envelope.

Path Parameters

​
id
string<uuid>
required

UUID of the appointment.

Response

The appointment.

​
id
string<uuid>
required
​
customer_name
string
required
​
customer_phone
string
required
​
scheduled_start
string<date-time>
required
​
scheduled_end
string<date-time>
required
​
status
enum<string>
required
Available options:
confirmed,
cancelled,
completed,
rescheduled,
no_show
​
created_at
string<date-time>
required
​
conversation_id
string<uuid> | null
​
lead_id
string<uuid> | null
​
offering_id
string<uuid> | null
​
customer_email
string<email> | null
​
location_text
string | null
​
google_calendar_event_id
string | null