List bookings

GET/api/v1/bookings

scope bookings:readPaginated

Lists the account’s bookings, most recently created first, with cursor pagination. To read a day or a week of the diary, filter with starts_after and starts_before; the order stays by creation time.

Query parameters

Name	Type	Description
`limit`optional	`integer`	Page size, 1–100Default: `20`
`cursor`optional	`string`	The `next_cursor` from the previous page
`status`optional	`string (enum)`	Only bookings in this state`scheduledconfirmedcompletedno_showcancelled`
`assignee_user_id`optional	`string (uuid)`	Only this member’s bookings
`contact_id`optional	`string (uuid)`	Only this contact’s bookings
`starts_after`optional	`string (date-time)`	Only bookings starting at or after this time
`starts_before`optional	`string (date-time)`	Only bookings starting before this time

Request

curl "https://your-crm.example.com/api/v1/bookings?limit=20&status=scheduled" \
  -H "Authorization: Bearer $RAABTA_API_KEY"

Response · 200 OK

{
  "data": [
    {
      "id": "c0ffee00-1234-4abc-9def-000000000001",
      "contact_id": "9d7e4c11-5a2b-4f7c-8e3d-2a1b0c9d8e7f",
      "assignee_user_id": "2f3e4d5c-6b7a-4c8d-9e0f-1a2b3c4d5e6f",
      "type": {
        "id": "b00c1e00-1234-4abc-9def-000000000002",
        "name": "Consultation"
      },
      "title": "Consultation",
      "location": "Clinic, Room 2",
      "notes": "Wants to discuss a website redesign",
      "starts_at": "2026-09-05T10:00:00.000Z",
      "ends_at": "2026-09-05T10:30:00.000Z",
      "status": "scheduled",
      "source": "api",
      "cancel_reason": null,
      "completed_at": null,
      "created_at": "2026-09-02T10:05:00.000Z",
      "updated_at": "2026-09-02T10:05:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": null,
    "has_more": false,
    "limit": 20
  }
}

Response

Wrapped in { data: [...], meta }

Name	Type	Description
`id`required	`string (uuid)`	UUID
`contact_id`required	`string (uuid) \| null`	The contact this booking is for
`assignee_user_id`required	`string (uuid) \| null`	The member who owns the slot
`type`required	`object \| null`	The booking type, when one is set
`type.id`required	`string (uuid)`	UUID
`type.name`required	`string`
`title`required	`string \| null`	Snapshotted from the type name at booking time
`location`required	`string \| null`	Snapshotted from the type at booking time
`notes`required	`string \| null`	Free text recorded with the booking
`starts_at`required	`string (date-time)`	ISO 8601 timestamp
`ends_at`required	`string (date-time)`	ISO 8601 timestamp
`status`required	`string (enum)`	Where the booking is in its life`scheduledconfirmedcompletedno_showcancelled`
`source`required	`string (enum)`	Who booked it: staff in the dashboard, the AI assistant, the public booking page, or this API`staffaipublicapi`
`cancel_reason`required	`string \| null`	What was recorded when it was cancelled
`completed_at`required	`string (date-time) \| null`	When it was marked completed
`created_at`required	`string (date-time)`	ISO 8601 timestamp
`updated_at`required	`string (date-time)`	ISO 8601 timestamp

Errors

Status	Code	When
400	`bad_request`	The request could not be parsed: malformed JSON, an invalid cursor, or a query parameter of the wrong shape.
400	`validation_error`	The body or query failed validation. `details` lists each failing field with a `path` and a `message`.
401	`unauthorized`	No usable API key: the Authorization header is missing or malformed, or the key is unknown, revoked or expired. The three are deliberately indistinguishable.
403	`forbidden`	The key is valid but lacks the scope this endpoint requires, or the request came from an address outside the key’s IP allowlist. The message says which.
403	`account_suspended`	The account this key belongs to is suspended. Rotating the key will not help; contact support.
422	`unprocessable`	The request was well-formed but cannot be carried out. `reason` is a stable string saying why (for example `outside_window` or `stage_not_in_pipeline`).
429	`rate_limited`	The per-key budget, or the per-IP budget for failed authentication, is exhausted. Honour `Retry-After` before retrying.
500	`internal`	Something failed on our side. Safe to retry with the same Idempotency-Key; quote `request_id` if it persists.