Saltar al contenido

List an envelope's documents

GET
/api/v1/envelopes/{id}/documents
curl --request GET \
--url https://sign-api.binarybridges.co/api/v1/envelopes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/documents \
--header 'Authorization: Bearer <token>'

Includes short-lived download URLs. Treat the URLs as secrets: they grant access to the document without a token. URLs are null unless the caller holds document:download in the envelope’s workspace.

id
required
string format: uuid

OK

Media type*/*
Array<object>
object
downloadUrl
string
filename
required
string
id
required
string format: uuid
signedUrl
string

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.

No such resource, or it belongs to another organisation. Deliberately not a 403: a 403 across a tenant boundary confirms the id exists.

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"
}