List envelopes
GET
/api/v1/envelopes
const url = 'https://sign-api.binarybridges.co/api/v1/envelopes?page=0&size=20';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://sign-api.binarybridges.co/api/v1/envelopes?page=0&size=20' \ --header 'Authorization: Bearer <token>'Paginated, newest first, scoped to the calling organisation by the token’s bb_sign_org_id claim. There is no request shape that names a different organisation. Only envelopes in workspaces the caller can read are listed; workspaceId narrows to one of them (an unreadable one yields an empty page). totalElements is capped at 10,000, with totalCapped set when the real count is larger.
Authorizations
Sección titulada «Authorizations»Parameters
Sección titulada «Parameters»Query Parameters
Sección titulada «Query Parameters»page
integer format: int32
size
integer format: int32
status
string
labels
string
fromDate
string format: date-time
toDate
string format: date-time
title
string
workspaceId
string format: uuid
Responses
Sección titulada «Responses»OK
Media type*/*
object
content
required
Array<object>
object
createdAt
required
string format: date-time
createdBy
string
documentCount
required
integer format: int32
expiresAt
string format: date-time
id
required
string format: uuid
labels
required
object
key
additional properties
string
message
string
orgId
required
string format: uuid
otpRequired
required
boolean
sequentialSigning
required
boolean
signers
required
Array<object>
object
email
required
string
id
required
string format: uuid
name
required
string
signOrder
required
integer format: int32
signedAt
string format: date-time
status
required
string
status
required
string
title
required
string
workspaceId
string format: uuid
workspaceName
string
page
required
integer format: int32
size
required
integer format: int32
totalCapped
required
boolean
totalElements
required
integer format: int64
totalPages
required
integer format: int32
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.