Skip to main content
GET
JavaScript

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Query Parameters

limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
after
string

Return items that come after this cursor

Maximum string length: 255
before
string

Return items that come before this cursor

Maximum string length: 255
customerExternalId
string

Filter by the exact external ID of the customer the contract belongs to

Maximum string length: 255
state
string

Filter by contract state. Supports comma-separated values for multiple states

Maximum string length: 255
name
string

Filter by exact contract name

Maximum string length: 255

Response

A cursor-paginated list of contracts, each with its next-invoice preview when available.

A cursor-paginated list of contracts

data
Contract · object[]
required
pagination
object
required

Pagination metadata including cursors for navigating through results