v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Bookings

Retrieve all booking series and one-off bookings.

Returns all bookings, including single (non-recurring) bookings and one entry per recurring series. For recurring bookings, only the first instance is returned — not the full list of occurrences. To retrieve individual instances in a series, use the /bookings/occurrences endpoint.

Required scopes: flex.space.bookings.read

get/api/v2/organizations/{orgSlug}/bookings

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

Filter by the _id of the booking. Supports both single id values (e.g., _id=603dfbc260f4054084125d33) and array operations (e.g., _id[$in]=603dfbc260f4054084125d33,603dfbc260f4054084125d34). Note: Multiple values in simple string format (e.g., _id=603dfbc260f4054084125d33,603dfbc260f4054084125d34) are not allowed - use _id[$in] format instead.

companystring

Example:603dfbc260f4054084125d30

Filter by company id.

memberstring

Example:603dfbc260f4054084125d33

Filter by member id.

locationstring

Example:603dfbc260f4054084125d31

Filter by location id.

resourcestring

Example:_id[$in]=66623dbf309024265739390a,66623dc53090242657393910

Filter by single or multiple resource ids.

seriesStartstring

Example:seriesStart[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter bookings based on the start date of the series or standalone booking. For recurring bookings, this refers to the start of the entire series (i.e., the first occurrence). For one-off bookings, it refers to the booking’s own start time. Supports date comparison filters: $gt, $gte, $lt, $lte

seriesEndstring

Example:seriesEnd[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter bookings based on the end date of the series or standalone booking. For recurring bookings, this refers to the end of the first occurrence (as returned by /bookings) or the end of each instance (in /bookings/occurrences). For one-off bookings, it refers to the booking’s own end time. Supports date comparison filters: $gt, $gte, $lt, $lte

referencestring

Example:_id[$in]=ref1,ref2

Filter by single or multiple reference numbers.

isCancelledboolean

Example:true

Determines whether the whole booking is canceled or not.

isTentativeboolean

Example:true

Determines whether the booking is tentative (not confirmed) or not.

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "properties": {
        "customProperty1": "value1",
        "customProperty2": "value2"
      },
      "_id": "603dfbc260f4054084125d39",
      "timezone": "Europe/London",
      "start": "2024-10-31T13:00:00.000Z",
      "end": "2024-10-31T13:30:00.000Z",
      "recurrence": {
        "rrule": "FREQ=WEEKLY;BYDAY=MO,WE,FR;COUNT=10",
        "exdates": [
          "2024-10-31T13:00:00.000Z"
        ]
      },
      "seriesStart": "2024-10-31T13:00:00.000Z",
      "seriesEnd": "2024-10-31T13:30:00.000Z",
      "location": "603dfbc260f4054084125d39",
      "company": "603dfbc260f4054084125d39",
      "member": "603dfbc260f4054084125d39",
      "resource": "603dfbc260f4054084125d39",
      "fees": [
        {
          "date": "2017-10-31T00:00:00.000Z",
          "extraFees": [],
          "credits": [
            {
              "count": 2,
              "credit": "594932ea518f3f150d306c89"
            }
          ],
          "customPrice": 100
        }
      ],
      "reference": "81LCV6S",
      "title": "Meeting with John",
      "rate": "603dfbc260f4054084125d39",
      "description": "Meeting with John at the office.",
      "isTentative": true,
      "extras": [
        {
          "_id": "603dfbc260f4054084125d39",
          "count": 2
        }
      ],
      "visitors": [
        "603dfbc260f4054084125d36",
        "603dfbc260f4054084125d37"
      ],
      "members": [
        "603dfbc260f4054084125d36",
        "603dfbc260f4054084125d37"
      ],
      "serviceSlots": {
        "before": 10,
        "after": 10
      },
      "source": "admin",
      "createdAt": "2022-02-07T10:03:33.169Z",
      "createdBy": "5bbb155174321f100085eac1",
      "modifiedAt": "2022-02-08T10:03:33.169Z",
      "modifiedBy": "5bbb155174321f100085eac1"
    }
  ]
}