Skip to main content
GET
List contracts

Authorizations

Authorization
string
header
required

HTTP Basic Auth using your API key. Send Authorization: Basic base64(key_id:key_secret).

Query Parameters

limit
integer
default:50

Number of items to return per request.

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

Opaque cursor from a previous response. Omit on the first request.

status
enum<string>

Filter by contract status.

Available options:
PROCESSING,
ACTIVE,
EXPIRED,
FAILED
carrier_name
string

Filter by carrier name (case-insensitive exact match).

Response

Cursor-paginated list of contracts.

data
object[]
required
pagination
object
required