@izak0s/spacebring-api - v7.1.0
    Preparing search index...

    Interface GetBookingsQuery

    Query parameters for sb.resources.bookings.list().

    interface GetBookingsQuery {
        "endDate[gt]"?: string;
        "endDate[gte]"?: string;
        "endDate[lt]"?: string;
        "endDate[lte]"?: string;
        "startDate[gt]"?: string;
        "startDate[gte]"?: string;
        "startDate[lt]"?: string;
        "startDate[lte]"?: string;
        customerRef?: string;
        endDate?: string;
        includeDeleted?: string;
        limit?: number;
        locationRef?: string;
        membershipRefOwner?: string;
        nextPageToken?: string;
        order?: string;
        resourceRef?: string;
        singleBookings?: string;
        startDate?: string;
        status?: string;
        type?: string;
        types?: string;
    }
    Index
    endDate[gt]? endDate[gte]? endDate[lt]? endDate[lte]? startDate[gt]? startDate[gte]? startDate[lt]? startDate[lte]? customerRef? endDate? includeDeleted? limit? locationRef? membershipRefOwner? nextPageToken? order? resourceRef? singleBookings? startDate? status? type? types?
    "endDate[gt]"?: string

    Matches bookings with endDate strictly after this date (ISO 8601).

    "endDate[gte]"?: string

    Matches bookings with endDate on or after this date (ISO 8601).

    "endDate[lt]"?: string

    Matches bookings with endDate strictly before this date (ISO 8601).

    "endDate[lte]"?: string

    Matches bookings with endDate on or before this date (ISO 8601).

    "startDate[gt]"?: string

    Matches bookings with startDate strictly after this date (ISO 8601).

    "startDate[gte]"?: string

    Matches bookings with startDate on or after this date (ISO 8601).

    "startDate[lt]"?: string

    Matches bookings with startDate strictly before this date (ISO 8601).

    "startDate[lte]"?: string

    Matches bookings with startDate on or before this date (ISO 8601).

    customerRef?: string

    UUID of the customer whose bookings to list.

    endDate?: string

    Use bracket-notation fields endDate[gt], endDate[gte], endDate[lt], endDate[lte] instead.

    includeDeleted?: string

    Use status "canceled" instead. Set to "true" to include deleted bookings.

    limit?: number

    Maximum number of bookings per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

    locationRef?: string

    UUID of the location whose bookings to list. Required when resourceRef is omitted.

    membershipRefOwner?: string

    Use customerRef instead. UUID of the customer whose bookings to list.

    nextPageToken?: string

    Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.

    order?: string

    Sort order as :, where field is startDate, endDate or createDate and direction is asc or desc.

    resourceRef?: string

    UUID of the resource whose bookings to list. Required when locationRef is omitted.

    singleBookings?: string

    Set to "true" to expand repeating bookings into single occurrences.

    startDate?: string

    Use bracket-notation fields startDate[gt], startDate[gte], startDate[lt], startDate[lte] instead.

    status?: string

    Comma-separated list of booking statuses to filter by, e.g. confirmed,canceled. Valid values: tentative, confirmed, canceled. Defaults to tentative, confirmed.

    type?: string

    Comma-separated list of resource types to filter by, e.g. room,hotDesk. Valid values: hotDesk, dedicatedDesk, office, parkingLot, room, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio, equipment, station. Defaults to all bookable types.

    types?: string

    Use type instead.

    Settings
    Member Visibility

    On This Page
    Properties