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

List envelope access links

GET

https://api.signater.com/v1/ecm/envelopes/{envelopeId}/access-links

Last modified:2026-10-26 02:41:45

Lists the access links of an envelope, newest first, with their status (Active, Expired or Revoked), whether they carry a password and how many times the envelope was opened through each. The response also carries the validity periods and the password minimum the platform accepts when creating a link. The URL and the password of a link are never listed; create a new link if they were lost.

Request

Authorization

Add parameter in header

x-api-token

Example:

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

Path Params

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//access-links?PageSize=undefined&PageNumber=undefined&OrderByDirection=undefined' \
--header 'x-api-token: <api-key>'

Responses

🟢200OK

application/json

Access links retrieved successfully

Bodyapplication/json

Example

{
    "items": [
        {
            "id": "8bc68302-db9d-4569-99f6-f35677283e6f",
            "name": "External audit",
            "createdById": "7a6751f2-c41b-476c-9e75-a57505d7ae56",
            "createdByName": "John Doe",
            "createdAtUtc": "2026-10-25T02:41:41.8785434Z",
            "expiresAtUtc": "2026-11-01T02:41:41.8785435Z",
            "status": "Active",
            "hasPassword": true,
            "accessCount": 3
        }
    ],
    "pagination": {
        "totalItems": 1,
        "pageSize": 10,
        "pageNumber": 1,
        "pageItems": 1
    },
    "maxValidityDays": 90,
    "defaultValidityDays": 7,
    "minPasswordLength": 8
}

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429

Modified at 2026-10-26 02:41:45

Create envelope access link

Create signature link