Skip to main content
GET
List contracts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string> | null

Only contracts standing in this status. Where a contract sent on a verification stands; every status but pending and withdrawing is final.

Available options:
pending,
withdrawing,
signed,
withdrawn,
expired,
failed
contract_workflow
string | null

Only contracts of this contract workflow.

workflow_key
string | null

Only contracts sent on this workflow's verifications.

reference_user_id
string | null

Only contracts sent on verifications carrying this reference of yours.

verification_id
string<uuid> | null

Only contracts sent on this verification.

contract_id
string<uuid> | null

Only the contract with this id.

limit
integer
default:50

Contracts per page.

Required range: 1 <= x <= 200
cursor
string | null

next_cursor from the previous page.

Response

One page of contracts, newest sent first.

One page of your contracts across your verifications, newest first.

contracts
ContractEntry · object[]
required

The page, newest first.

next_cursor
string | null
required

Pass as cursor to read the next page. Null on the last one.