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

List usage allocation

GET

https://api.signater.com/v1/account/usage/allocation

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

Lists who consumed the envelope balance, per vault, per member or per vault and member, largest first, with the share of the account. Filters: vault, owner 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/account/usage/allocation?vaultId=undefined&ownerId=undefined&fromDate=undefined&toDate=undefined&timeZone=undefined&groupBy=undefined&orderByColumn=undefined&pageSize=undefined&pageNumber=undefined&orderByDirection=undefined' \
--header 'x-api-token: <api-key>'

Responses

🟢200OK

application/json

Allocation listed successfully

Bodyapplication/json

Example

{
    "items": [
        {
            "vaultId": "867f3a98-ec66-42f4-abbc-5980239e4a28",
            "vaultName": "string",
            "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
            "ownerName": "string",
            "ownerEmail": "string",
            "ownerAvatar": "string",
            "usersCount": 0,
            "vaultsCount": 0,
            "consumed": 0,
            "share": 0,
            "lastConsumedAtUtc": "2019-08-24T14:15:22.123Z"
        }
    ],
    "pagination": {
        "totalItems": 0,
        "pageSize": 0,
        "pageNumber": 0,
        "pageItems": 0
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429

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

List usage statement

List usage storage