Signatures

List signature envelopes (module status)

Polling snapshot: the same current record or collection as the corresponding read endpoint, including its state and progress. List filters, defaults and pagination also apply here. This is not an event history or a changes-since feed. Poll at a sensible interval (start with 30 seconds), respect Retry-After on 429 and stop when the required terminal state is reached.

What is out for signature, and what has come back. Filter by status: sent and partially_signed are the ones still waiting on somebody. Each row says who has signed and who has not, which is usually the actual question.

Examples

  • What is still waiting to be signed? GET /api/v1/rest/firme/status?open_only=true
  • Show me the completed ones GET /api/v1/rest/firme/status?status=completed
get/api/v1/rest/firme/status

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/firme/status
  • Auth: HTTP bearer

Query parameters

status'draft' | 'sent' | 'partially_signed' | 'completed' | 'declined' | 'expired' | 'voided'

Omit for everything. sent/partially_signed are still open.

open_onlyboolean

Shorthand for "still waiting on a signature".

querystring

Free text over the envelope title.

limitinteger

Rows to return, 1–100. Default 20.

cursorstring

Opaque cursor from a previous call’s nextCursor, to continue.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

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