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

List envelope accesses of the account

GET

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

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

Lists who opened the envelopes of the account, newest first: how the access was granted, the person when known, the access link, the IP, the place and the access policy in force at that moment. Filters: vault, grant, whether the envelope was open to anyone with its link, and a period of up to 366 days counted in timeZone. Administrators only.

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/accesses?vaultId=undefined&grant=undefined&policyWasOpen=undefined&fromDate=undefined&toDate=undefined&timeZone=undefined&orderByColumn=undefined&pageSize=undefined&pageNumber=undefined&orderByDirection=undefined' \
--header 'x-api-token: <api-key>'

Responses

🟢200OK

application/json

Accesses listed successfully

Bodyapplication/json

Example

{
    "items": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "createdAtUtc": "2019-08-24T14:15:22.123Z",
            "grant": "Public",
            "who": {
                "name": "string",
                "email": "string"
            },
            "accessLink": {
                "name": "string",
                "createdByName": "string",
                "hasPassword": true
            },
            "ip": "string",
            "userAgent": "string",
            "location": {
                "city": "string",
                "regionCode": "string",
                "country": "string",
                "countryCode": "string"
            },
            "policyOpenDays": 0,
            "policyAllowSignerAccess": true,
            "policyWasOpen": true,
            "envelope": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "name": "string"
            }
        }
    ],
    "pagination": {
        "totalItems": 0,
        "pageSize": 0,
        "pageNumber": 0,
        "pageItems": 0
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429

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

List pending envelopes

Create signature link