Fetch one envelope

GET

/api/v1/envelopes/{id}

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

• Production

Returns the envelope with its signers and their current statuses.

Authorizations

• clientCredentials

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

OK

Media type*/*

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

400

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

401

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

403

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

404

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