list agreements

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 100
Defaults to 20

Number of results per page

string

Opaque pagination cursor value. Set by following "next" links.

state
array

Filter agreements by state. Multiple values can be separated by commas.

state
string

Filter agreements by initiator name. The filtering is case sensitive and must be an exact match.

uuid

Filter agreements initiated by the client. Accepts the client_id supplied via initiator.client_id when the agreement was created. Only agreements created with the supplied initiator.client_id are matched.

date

Filter by minimum created_at date. ISO8601 format.

date

Filter by maximum created_at date. ISO8601 format.

Headers
string
^\d{8}$
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json