Saltar al contenido

Envelope counts by status

GET
/api/v1/envelopes/stats
curl --request GET \
--url https://sign-api.binarybridges.co/api/v1/envelopes/stats \
--header 'Authorization: Bearer <token>'

Counts for the calling organisation, for a dashboard tile, over the workspaces the caller can read (workspaceId narrows to one). Cheap: one grouped count, not a list.

workspaceId
string format: uuid

OK

Media type*/*
object
cancelled
required
integer format: int64
completed
required
integer format: int64
draft
required
integer format: int64
expired
required
integer format: int64
inProgress
required
integer format: int64
sent
required
integer format: int64
total
required
integer format: int64

The request was malformed or failed validation.

Media typeapplication/json
object
code
required
string
error
required
string
message
required
string
path
required
string
quota
object
current
required
integer format: int64
dimension
required
string
limit
required
integer format: int64
status
required
integer format: int32
timestamp
required
string format: date-time
traceId
string

Example generated

{
"code": "example",
"error": "example",
"message": "example",
"path": "example",
"quota": {
"current": 1,
"dimension": "example",
"limit": 1
},
"status": 1,
"timestamp": "2026-04-15T12:00:00Z",
"traceId": "example"
}

No credentials, or a token this organisation’s credentials cannot present. Produced by the security filter chain, so there is no response body.

Authenticated, but the token lacks the role this operation requires. No response body.