This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

List envelopes

GET

https://api.signater.com/v1/ecm/envelopes

Last modified:2026-11-04 04:23:46

Lists the envelopes in the vaults the member of the token reaches, or, with scope=Account, every envelope of the account (administrators only; members get 403). Filters combine: status, vaults, owner, a search over the id, the name and the signers' names and e-mails, the creator, removed envelopes and a period. The period is fromDate and toDate, two days counted in timeZone (IANA, UTC when omitted), up to 366 days, applied to the date chosen in dateField. Each item carries a summary of its signers.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.signater.com/v1/ecm/envelopes?status=undefined&vaultIds=undefined&ownerId=undefined&search=undefined&dateField=undefined&fromDate=undefined&toDate=undefined&timeZone=undefined&expiresBeforeDate=undefined&systemCreator=undefined&includeRemoved=undefined&scope=undefined&orderByColumn=undefined&pageSize=undefined&pageNumber=undefined&orderByDirection=undefined' \
--header 'x-api-token: <api-key>'

Responses

🟢200OK

application/json

Envelopes listed successfully

Bodyapplication/json

Example

{
    "items": [
        {
            "id": "8f1b6a52-4f3e-4a59-9a8e-3f2c1d7b6e10",
            "name": "Service agreement",
            "status": "Published",
            "systemCreator": "Api",
            "signInOrder": false,
            "vaultId": "2c4e6a80-1b3d-4f5a-8c7e-9d0f1a2b3c4d",
            "vaultName": "Contracts",
            "ownerId": "5a7c9e1f-3b5d-4f7a-9c1e-2b4d6f8a0c2e",
            "ownerName": "Ana Lima",
            "ownerAvatar": null,
            "createdAtUtc": "2026-10-01T13:00:00Z",
            "publishedAtUtc": "2026-10-01T13:05:00Z",
            "outcomeAtUtc": null,
            "expiresAtUtc": "2026-10-31T03:00:00Z",
            "cancellationReason": null,
            "signersCount": 2,
            "signedSignersCount": 1,
            "isRemoved": false,
            "signers": [
                {
                    "id": "0e2f4a6c-8b1d-4e3f-a5c7-9b1d3f5a7c9e",
                    "name": "Bruno Dias",
                    "email": "bruno@example.com",
                    "status": "Approved"
                },
                {
                    "id": "1f3a5c7e-9d2b-4f4a-b6d8-0c2e4a6c8e0a",
                    "name": "Carla Souza",
                    "email": "carla@example.com",
                    "status": "None"
                }
            ]
        }
    ],
    "pagination": {
        "totalItems": 1,
        "pageSize": 10,
        "pageNumber": 1,
        "pageItems": 1
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429

Modified at 2026-11-04 04:23:46

Get access link password

List pending envelopes