Retrieve all booking occurrences (expanded instances).

get

https://app.officernd.com/api/v2/organizations/{orgSlug}/bookings/occurrences

Returns a flat list of individual booking occurrences within a given time period. This includes both one-off bookings and all expanded instances from recurring series. Useful for calendars, availability checks, and reports. If no pagination is used, the maximum supported period is 1 year.

Required scopes: flex.space.bookings.read

Path Params

orgSlug

string

required

organization slug

Query Params

_id

string

Filter by booking id.

company

string

Filter by company id.

member

string

Filter by member id.

location

string

Filter by location id. Supports both single location values (e.g., location=603dfbc260f4054084125d31) and array operations (e.g., location[$in]=603dfbc260f4054084125d31,603dfbc260f4054084125d32).

resource

string

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

isCancelled

boolean

Filter occurrences by whether the underlying booking is canceled or not.

isTentative

boolean

Filter occurrences by the underlying booking's tentative (not confirmed) status. This matches the static tentative field set at booking creation time (e.g. via a booking policy that requires approval); it does not evaluate the dynamic per-occurrence tentative state that is computed at read time from the booking's accounted period.

seriesStart

date-time

required

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. Date comparison filters ($gt, $gte, $lt, $lte) are accepted, but operators are ignored — only the date value is used.

seriesEnd

date-time

required

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. Date comparison filters ($gt, $gte, $lt, $lte) are accepted, but operators are ignored — only the date value is used.

$select

string

Select fields to return

$cursorNext

string

$cursorPrev

string

$limit

number

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200