Envelopes

List envelopes

One page of the credential's workspace envelopes, newest first by createdAt. There is no query parameter that widens the list beyond the workspace the credential is bound to.

Each row carries the envelope's status, its document, and a signer roster reduced to id, name, email, and status. Field placement and per-signer timestamps are not in the list: fetch GET /envelopes/{envelopeId} for those.

status filters to a single envelope status, or all. A status value outside the enum is a validation_error (400), not an empty page.

get/envelopes

Request

  • Base URL: https://inkseal.net/api/v1
  • URL: https://inkseal.net/api/v1/envelopes
  • Auth: HTTP bearer

Query parameters

pageinteger

1-based page number.

limitinteger

Items per page.

status'all' | 'draft' | 'sending' | 'pending' | 'completing' | 'completed' | 'declined' | 'voided' | 'expired'

Restrict the page to one envelope status. Defaults to all.

Response

One page of envelopes.

Example response

{
  "data": [
    {
      "id": "Jd3kR8sVqW2nX5cY7bLmP",
      "status": "pending",
      "subject": "Master Services Agreement",
      "signingOrder": "sequential",
      "document": {
        "id": "Ku7bV2xQpL9mNr4sT1yZa",
        "filename": "master-services-agreement.pdf"
      },
      "signers": [
        {
          "id": "Sg2wY6nT4qV8mR1xK9bDz",
          "name": "Dana Reyes",
          "email": "dana@acme.test",
          "role": "signer",
          "status": "sent"
        }
      ],
      "sentAt": "2026-08-21T09:20:44.000Z",
      "expiresAt": "2026-09-20T09:20:41.000Z",
      "createdAt": "2026-08-21T09:19:58.000Z"
    }
  ]
}

Changes

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