v1
documents

List Documents

List envelopes in the caller's organization.

Same filter semantics as dashboard JWT GET /api/documents: offset, limit, status, recipient (email substring), date_from / date_to (ISO-8601 inclusive on created_at; 422 if unparseable), q (name, filename, recipient name/email, and id when the term looks like one), sort (created_at, updated_at, name, status; unknown → created_at), direction (asc or desc; unknown → desc). limit max 50.

Includes unsent drafts (status draft or ready_to_send, session_id null) in the default All mix. Pass status=draft or status=ready_to_send to list only those. Other status values are session statuses (pending, in_progress, completed, voided, declined, expired, cancelled → voided+declined, deleted).

Rows are session-centric: one document with N sessions is N items. Each item includes a thin recipients[] (recipient_id, email, name, status, can_remind) so Remind can map without a Get Status hop. Sender email and the rich session payload stay on GET /api/v1/documents/{document_id}.

get/api/v1/documents

Request

  • Base URL: https://zsign.io (the document declares no server; this is the origin it was published from)
  • URL: https://zsign.io/api/v1/documents
  • Auth: HTTP bearer

Query parameters

offsetinteger
limitinteger
statusstring nullable
recipientstring nullable
date_fromstring nullable
date_tostring nullable
qstring nullable
sortstring nullable
directionstring nullable

Response

Successful Response

totalinteger required
offsetinteger required
limitinteger required

Changes

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