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

    Interface GetContractsQuery

    Query parameters for sb.contracts.list().

    interface GetContractsQuery {
        "createDate[gte]"?: string;
        "createDate[lte]"?: string;
        customerRef?: string;
        limit?: number;
        locationRef?: string;
        nextPageToken?: string;
        q?: string;
        status?: string;
    }
    Index
    createDate[gte]? createDate[lte]? customerRef? limit? locationRef? nextPageToken? q? status?
    "createDate[gte]"?: string

    Filter contracts created on or after this date (ISO 8601). Use with createDate[lte] for a range.

    "createDate[lte]"?: string

    Filter contracts created on or before this date (ISO 8601). Use with createDate[gte] for a range.

    customerRef?: string

    UUID of the customer (membership or company). Provide customerRef or locationRef; when set, returns only that customer's contracts.

    limit?: number

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

    locationRef?: string

    UUID of the location. Provide customerRef or locationRef; when set, returns contracts in that location.

    nextPageToken?: string

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

    q?: string

    Case-insensitive search by contract title. Requires customerRef or locationRef to scope the search.

    status?: string

    Filter by contract status. Comma-separated values, e.g. draft,issued.

    Supported values:

    • draft — created but not sent
    • issued — sent, awaiting signature
    • signed — active
    • declined — rejected
    • terminated — cancelled after signing

    Settings
    Member Visibility

    On This Page
    Properties