Sign in

v1

latestOpenAPI 3.0.02026-07-26870415.2 KB
appointments

List appointments

Returns cursor-paginated appointments backed by the Conduit booking service. v1 exposes allocation + external_id context only; full appointment details (scheduled time, assigned agent, location) are retrievable from the booking service using external_id.

get/v1/appointments

Query parameters

workspace_idstring required

Workspace to query.

Example:j57demo8f8x7c9v0n2q4r6t8y1u3i5o
limitinteger

Page size. Defaults to 20. Max 100.

cursorstring

Pagination cursor returned as next_cursor on the previous page.

order'asc' | 'desc'

Sort direction over scheduled start time. Defaults to desc (most recently scheduled first).

status'awaiting_response' | 'awaiting_confirmation' | 'confirmed' | 'cancelled' | 'completed' | 'no_show' | 'rescheduled'

Filter by appointment status. Use completed, no_show, cancelled, or rescheduled to compute booking efficacy rates.

start_afterstring date-time

Only return appointments scheduled at or after this ISO 8601 timestamp.

Example:2026-04-01T00:00:00.000Z
start_beforestring date-time

Only return appointments scheduled strictly before this ISO 8601 timestamp.

Example:2026-05-01T00:00:00.000Z

Response

Appointments

next_cursorstring nullable required
has_moreboolean required

Example response

{
  "data": [
    {
      "id": "ar77c0dy0mgdpzmqz6tesry8w184002s",
      "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
      "contact_id": "ph77c0dy0mgdpzmqz6tesry8w184002s",
      "external_id": "bk_vcNpA4g3iJWvlkY1",
      "status": "confirmed",
      "start_at": "2026-04-21T13:30:00.000Z",
      "end_at": "2026-04-21T13:45:00.000Z",
      "duration_ms": 900000,
      "origin": "direct",
      "notes": "Tour of the property, coming from Airbnb inquiry.",
      "generated_context": "Guest asked about check-in flexibility.",
      "short_link_id": "sl_8m3qxv2",
      "strength_indicator": 0.82,
      "booking_info": {
        "name": "Taylor Reid",
        "email": "taylor.reid@example.com",
        "phone": "+14155550123",
        "notes": null
      },
      "references": [
        {
          "id": "listing_456",
          "type": "unit",
          "value": "Unit 4B"
        }
      ],
      "last_synced_at": "2026-04-18T16:12:05.000Z",
      "created_at": "2026-04-18T16:12:00.000Z"
    }
  ],
  "next_cursor": "page-token",
  "has_more": true
}