v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
Contract

List Contracts

Retrieves a list of Contracts by Organization ID. Supports pagination and includes various query parameters to filter the Contracts returned based on Contract IDs or short codes.

get/organizations/{orgId}/contracts

Path parameters

orgIdstring required

The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.

Query parameters

pageSizeinteger

Specifies the maximum number of Contracts to retrieve per page.

nextTokenstring

The nextToken for multi-page retrievals. It is used to fetch the next page of Contracts in a paginated list.

idsstring[]

An optional parameter to filter the list based on specific Contract unique identifiers (UUIDs).

codesstring[]

An optional parameter to retrieve specific Contracts based on their short codes.

accountIdstring nullable

Response

Returns a list of Contracts

nextTokenstring