Retrieve an Appointment Recording

Use this endpoint to fetch a single appointment recording by its identifier. You can look up an appointment using either the Shilo-generated recording UUID or the external recording ID that your integration provided when the appointment was ingested. This is useful for confirming that an appointment has been processed or for retrieving its metadata before fetching analysis or transcript data.

Endpoint

GET https://api.shilo.ai/api/v1/appointments/{identifier}

Authentication

All requests require your API key in the x-api-key header.

Path Parameters

string

required

The unique identifier for the appointment recording. Two formats are accepted:

{uuid} — The Shilo recording UUID (e.g., ee6f2136-b94a-4438-9335-3acf5b2a0d31)
external_recording_id:{string} — The external recording ID your integration provided (e.g., external_recording_id:ext-789)

Response

A successful request returns HTTP 200 with the matching Appointment object.

string

required

The Shilo recording UUID for this appointment.

string

required

Always "appointment" for records returned by this endpoint.

string

required

The ISO-8601 timestamp indicating when the appointment recording was created in Shilo.

string | null

The Shilo UUID of the user associated with this appointment. null if no user is matched.

string | null

The external user ID provided by your integration at the time the appointment was created. null if not provided.

string | null

The external contact ID provided by your integration at the time the appointment was created. null if not provided.

string | null

The external recording ID provided by your integration, if any. null if not provided.

Error Responses

Status	Description
`400 Bad Request`	The `identifier` path parameter is malformed or uses an unsupported format.
`404 Not Found`	No appointment recording was found matching the provided identifier.

Example Request

curl --request GET \
  --url "https://api.shilo.ai/api/v1/appointments/ee6f2136-b94a-4438-9335-3acf5b2a0d31" \
  --header "x-api-key: YOUR_API_KEY"

By external recording ID:

curl --request GET \
  --url "https://api.shilo.ai/api/v1/appointments/external_recording_id:ext-789" \
  --header "x-api-key: YOUR_API_KEY"

Example Response

{
  "id": "ee6f2136-b94a-4438-9335-3acf5b2a0d31",
  "type": "appointment",
  "created_date": "2030-09-24T12:34:56Z",
  "user_id": "ee6f2136-b94a-4438-9335-3acf5b2a0d31",
  "external_user_id": "432",
  "external_contact_id": "4534",
  "external_recording_id": "ext-789"
}

Overview

Calls

Appointments

Roleplays

Contacts

Users

Invitations

Metrics

Coaching

Retrieve an Appointment Recording — Shilo API

Endpoint

Authentication

Path Parameters

Response

Error Responses

Example Request

Example Response

​Endpoint

​Authentication

​Path Parameters

​Response

​Error Responses

​Example Request

​Example Response

Endpoint

Authentication

Path Parameters

Response

Error Responses

Example Request

Example Response