Contracts

List contracts

Every contract the shop has generated, newest first. Each row carries the campaign and creator it was sent to, the full terms snapshot the document was rendered from, the signing status and both signature timestamps.

Filter by status (draft/sent/active/expired/voided/delivery_failed), by creator_id, by campaign_id, or by expiring_within_days to find active contracts about to lapse. status=expired and expiring_within_days are mutually exclusive — expiry is evaluated lazily against today's date, so asking for both is contradictory.

Cursor-paginated: pass the next_cursor from the previous response to get the next page. A null next_cursor means the last page. Single-shop only.

get/contracts

Query parameters

status'draft' | 'sent' | 'active' | 'expired' | 'voided' | 'delivery_failed' nullable

Restrict to one signing status.

Restrict to one signing status.

creator_idinteger nullable

Restrict to contracts sent to one creator.

Restrict to contracts sent to one creator.

campaign_idinteger nullable

Restrict to contracts generated for one campaign.

Restrict to contracts generated for one campaign.

expiring_within_daysinteger nullable

Only active contracts expiring within this many days.

Only active contracts expiring within this many days.

cursorstring nullable

Opaque cursor from next_cursor.

Opaque cursor from next_cursor.

limitinteger

Rows per page (max 200).

Rows per page (max 200).

Response

Successful Response

next_cursorstring nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.