Skip to main content
GET
Retrieve contracts

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

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>

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

limit
integer

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

Required range: 1 <= x <= 100
locationRef
string<uuid>

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

Response

OK

contracts
object[]
required

List of contracts.

nextPageToken
string

Pagination token to fetch the next page of results.

searchQueryNext
string

Search query parameters for the next page of results. Includes all filters used to fetch the current page.