Skip to content
Seal
Esc
↑↓navigate↵open⌘Jpreview

List documents

Returns a paginated list of documents in your organization. Use the next_cursor from the response to fetch the next page.

GET/documents
Authorization
AuthorizationBearer token · headerrequired

Pass your API key as a Bearer token. API keys are scoped to specific operations — configure scopes in your organization's Settings → Developer → API Keys.

Query parameters
limitinteger

Number of results per page

min 1 · max 100 · default: 20
cursorstring

Pagination cursor from the previous response

statusDocumentStatus

Filter documents by status

Allowed:draftsentin_progresscompletedcancelleddeclined
Responses
200

OK

dataDocument[]required
Show properties
Array of Document
idstringrequired

Unique document identifier

titlestringrequired
descriptionstring
statusDocumentStatusrequired

Current workflow status of a document

Allowed:draftsentin_progresscompletedcancelleddeclined
created_atstring<date-time>required
updated_atstring<date-time>required
recipients_countintegerrequired

Total number of recipients

signed_countintegerrequired

Number of recipients who have completed their action

deadlinestring<date-time>

Signing deadline

download_urlstring<uri>

Pre-signed URL to download the document PDF

recipientsRecipient[]

Recipient list (only included when include_recipients=true)

Show properties
Array of Recipient
idstringrequired
emailstring<email>required
namestringrequired
roleRecipientRolerequired
  • signer — must provide a signature to complete the document
  • approver — must click Approve; no signature drawn
  • viewer — receives a copy but has no action required
Allowed:signerapproverviewer
statusRecipientStatusrequired
Allowed:pendingviewedsignedapproveddeclined
orderinteger

Position in sequential signing order

signed_atstring<date-time>
viewed_atstring<date-time>
declined_atstring<date-time>
decline_reasonstring
has_morebooleanrequired
next_cursorstring
401

Missing or invalid API key

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

Try it
Server
Authorization
Parameters
Request
curl -X GET "https://api.seal.nyc/api/v1/documents" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "data": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "status": "draft",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "recipients_count": 0,
      "signed_count": 0,
      "deadline": "2019-08-24T14:15:22Z",
      "download_url": "http://example.com",
      "recipients": [
        {
          "id": "string",
          "email": "user@example.com",
          "name": "string",
          "role": "signer",
          "status": "pending",
          "order": 0,
          "signed_at": "2019-08-24T14:15:22Z",
          "viewed_at": "2019-08-24T14:15:22Z",
          "declined_at": "2019-08-24T14:15:22Z",
          "decline_reason": "string"
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}