Skip to main content
GET
List a contract's amendments

Authorizations

Authorization
string
header
required

An API key created in Settings, sent as Authorization: Bearer <key>.

Query Parameters

contractId
string<uuid>
required

The contract whose amendments to list.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
statuses
string

Only amendments whose status is one of these, separated by commas — for example DRAFT,FINALIZED. The statuses are DRAFT, FINALIZING, FINALIZED, VOIDING, VOIDED. Leave it out for every status.

startingAfter
string

The nextCursor of the previous page, to read the page after it.

Required string length: 1 - 1024
Pattern: ^[A-Za-z0-9._-]+$
endingBefore
string

The prevCursor of the previous page, to read the page before it.

Required string length: 1 - 1024
Pattern: ^[A-Za-z0-9._-]+$
limit
integer
default:50

Rows per page, 1 to 100.

Required range: 1 <= x <= 100

Response

Successful response

data
object[]
required
hasMore
boolean
required
nextCursor
string
prevCursor
string