Skip to content
VocenyaDocs

Bookings

Appointments the AI booked into your calendar or field-service software. Needs bookings:read.

Endpoints

List bookings

GET/bookings

Needs the bookings:read scope

Appointments the AI booked, most recently booked first. Filter by appointment time.

Query parameters

  • starts_afterstring (date-time)Optional

    Appointments starting at or after this time (ISO 8601).

  • starts_beforestring (date-time)Optional

    Appointments starting before this time (ISO 8601).

  • per_pageintegerOptional

    How many items per page, 1 to 100.

    Minimum 1 · Maximum 100

  • cursorstring | nullOptional

    The meta.next_cursor (or meta.prev_cursor) of the previous page.

    Up to 1024 characters

Returns

Paginated set of BookingResource

  • dataarray of objectsRequired
  • linksobjectRequired
  • metaobjectRequired

Responses

  • 200Paginated set of BookingResource
  • 401The API key is missing, invalid, expired or revoked.
  • 403The key does not have the bookings:read scope.
  • 422Validation error
  • 429Too many requests for this key. Wait for the Retry-After seconds.
curl https://vocenya.com/api/public/v1/bookings \
  -H "Authorization: Bearer $VOCENYA_API_KEY"
Response 200
{
  "data": [
    {
      "id": 1,
      "livemode": true,
      "provider": "google_calendar",
      "external_reference": "string",
      "starts_at": "2026-10-02T14:03:11+00:00",
      "duration_minutes": 1,
      "name": "Maria Rivera",
      "phone_number": "+15125550123",
      "call_id": 1,
      "outbound_call_id": 1,
      "created_at": "2026-10-02T14:03:11+00:00"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "path": "string",
    "per_page": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}

Get a booking

GET/bookings/{booking}

Needs the bookings:read scope

Path parameters

  • bookingintegerRequired

    The booking id.

Returns

BookingResource

  • dataobjectRequired

Responses

  • 200BookingResource
  • 401The API key is missing, invalid, expired or revoked.
  • 403The key does not have the bookings:read scope.
  • 404No record with that id belongs to your account.
  • 429Too many requests for this key. Wait for the Retry-After seconds.
curl https://vocenya.com/api/public/v1/bookings/64 \
  -H "Authorization: Bearer $VOCENYA_API_KEY"
Response 200
{
  "data": {
    "id": 1,
    "livemode": true,
    "provider": "google_calendar",
    "external_reference": "string",
    "starts_at": "2026-10-02T14:03:11+00:00",
    "duration_minutes": 1,
    "name": "Maria Rivera",
    "phone_number": "+15125550123",
    "call_id": 1,
    "outbound_call_id": 1,
    "created_at": "2026-10-02T14:03:11+00:00"
  }
}