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. Results can be ordered by start date-time using $sort, within a limited date range (see $sort).

Required scopes: flex.space.bookings.read

Path Params

orgSlug

string

required

organization slug

Query Params

_id

string

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.

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

$sort

string

^start:(asc|desc)$

Orders the occurrences by their start date-time. Use start:asc or start:desc; only start is supported. Optional - if omitted, occurrences are returned without a guaranteed order. When $sort is used, seriesEnd must be before the end of the last day of the second month after the current month (UTC), otherwise the request is rejected with 400. For example, during November seriesEnd must be before 31 January 23:59:59.999 UTC. Send the same $sort value and the same filters with every $cursorNext / $cursorPrev request. Occurrences with the same start time have no guaranteed relative order. Bookings with a preparation buffer are ordered by their start minus that buffer, so bookings starting within a buffer of each other may appear out of order. Right after a month change, occurrences of recurring bookings in the newest month of the allowed range may take a short time to appear.

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