Skip to main content
GET
Retrieve contracts

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Scopes

invoices

Read and write contract, credit notes, discounts and invoices

invoices.readonly

Read contracts, credit notes, discounts and invoices

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). 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. When set, returns contracts in that location. Omit both locationRef and customerRef to list contracts across every location of the network.

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, within customerRef or locationRef when given and across the network otherwise.

status
string

Filter by status: 'draft' created and not sent yet, 'issued' sent and waiting for signatures, 'signed' signed by everyone and active, 'declined' a signer declined it or it expired unsigned, 'terminated' ended by an admin after it was signed. Defaults to every status. Comma-separated, one or more of: draft, issued, signed, declined, terminated.

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.