One envelope, in full

GET

/envelopes/{id}

const url = 'https://api.sealpost.app/v1/envelopes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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://api.sealpost.app/v1/envelopes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Scope envelopes:read. Another tenant’s envelope is a 404.

Authorizations

ApiKey

Parameters

Path Parameters

required

string format: uuid

Responses

200

The envelope.

application/json

object

required

string format: uuid

status

required

string

Allowed values: draft sent in_progress completed declined cancelled expired

test_mode

required

boolean

title

required

string

message

string | null

subject

string | null

sequential

boolean

flexible_signing

boolean

allow_decline

boolean

allow_reassign

boolean

requester_name

string | null

requester_email

string | null

redirect_url

string | null

redirect_decline_url

string | null

expires_at

string | null format: date-time

language

string

metadata

object

key

additional properties

string

client_reference

string | null

page_count

integer | null

files

required

Array<object>

object

required

string format: uuid

envelope_id

Null until the file is attached to an envelope.

string | null format: uuid

position

1-based order within the envelope.

integer | null

name

required

string

kind

The caller’s label for the document type, e.g. merchant_application; used to split a signed envelope back into its documents.

string | null

mime

required

string

bytes

required

integer

sha256

SHA-256 (hex) of the original bytes, exactly as uploaded. Null while pending.

string | null

pdf_version

string | null

page_count

integer | null

page_sizes

Array<object> | null

One page’s visual size in points (after /Rotate).

object

required

number

required

number

rotate

required

integer

Allowed values: 0 90 180 270

status

required

string

Allowed values: pending converting ready failed

error

string | null

upload_expires_at

When an unattached upload is swept (30 days). Null once attached.

string | null format: date-time

created_at

required

string format: date-time

recipients

required

Array<object>

object

required

string format: uuid

kind

required

string

name

required

string

email

required

string

phone

string | null

language

string

routing_order

required

integer

required

boolean

auth_method

string

status

required

string

Allowed values: pending sent viewed signed declined reassigned bounced expired cancelled removed

deliver_email

boolean

redirect_url

string | null

position

integer

sent_at

string | null format: date-time

signed_at

string | null format: date-time

fields

required

Array<object>

Always returned in points (unit: pt), origin top-left; source is what you sent.

object

required

string format: uuid

identifier

required

string

type

required

string

file_id

required

string format: uuid

recipient_id

string | null format: uuid

page

required

integer

required

number

required

number

width

required

number

height

required

number

unit

required

string

Allowed values: pt

source

object | null

requirement

string

label

string | null

placeholder

string | null

options

Array<string> | null

group

string | null

value

string | null

sent_at

string | null format: date-time

completed_at

string | null format: date-time

created_at

required

string format: date-time

updated_at

string format: date-time

Example

{
  "status": "draft",
  "files": [
    {
      "page_sizes": [
        {
          "rotate": 0
        }
      ],
      "status": "pending"
    }
  ],
  "recipients": [
    {
      "status": "pending"
    }
  ],
  "fields": [
    {
      "unit": "pt"
    }
  ]
}

Headers

Sign-Request-Id

string

Unique id of this request (req_…). Quote it in support requests.

401

No key, an unknown key, or a revoked or expired key.

application/problem+json

RFC 9457 problem details plus a stable code and the request_id.

object

type

required

https://sealpost.app/errors/{code}

string format: uri

title

required

string

status

required

integer

detail

Human-readable, safe to show to a developer, never contains secrets or signer data.

string

instance

The request path.

string

code

required

Stable machine-readable code from the catalogue (docs/errors.md).

string

request_id

required

string

errors

Field-level detail on validation_failed.

Array<object>

object

param

required

JSON pointer-ish path, e.g. scopes[2].

string

message

required

string

Example

{
  "type": "https://sealpost.app/errors/insufficient_scope",
  "title": "Forbidden",
  "status": 403,
  "detail": "This key lacks the api_keys:write scope.",
  "code": "insufficient_scope",
  "request_id": "req_01J9ZK3V8Q4M2XQ7W0E5D1R6TA"
}

Headers

Sign-Request-Id

string

Unique id of this request (req_…). Quote it in support requests.

403

The key is valid but lacks the scope, or a test key tried a live-only action.

application/problem+json

RFC 9457 problem details plus a stable code and the request_id.

object

type

required

https://sealpost.app/errors/{code}

string format: uri

title

required

string

status

required

integer

detail

Human-readable, safe to show to a developer, never contains secrets or signer data.

string

instance

The request path.

string

code

required

Stable machine-readable code from the catalogue (docs/errors.md).

string

request_id

required

string

errors

Field-level detail on validation_failed.

Array<object>

object

param

required

JSON pointer-ish path, e.g. scopes[2].

string

message

required

string

Example

{
  "type": "https://sealpost.app/errors/insufficient_scope",
  "title": "Forbidden",
  "status": 403,
  "detail": "This key lacks the api_keys:write scope.",
  "code": "insufficient_scope",
  "request_id": "req_01J9ZK3V8Q4M2XQ7W0E5D1R6TA"
}

Headers

Sign-Request-Id

string

Unique id of this request (req_…). Quote it in support requests.

404

No such resource in this tenant. Another tenant’s resource is also a 404.

application/problem+json

RFC 9457 problem details plus a stable code and the request_id.

object

type

required

https://sealpost.app/errors/{code}

string format: uri

title

required

string

status

required

integer

detail

Human-readable, safe to show to a developer, never contains secrets or signer data.

string

instance

The request path.

string

code

required

Stable machine-readable code from the catalogue (docs/errors.md).

string

request_id

required

string

errors

Field-level detail on validation_failed.

Array<object>

object

param

required

JSON pointer-ish path, e.g. scopes[2].

string

message

required

string

Example

{
  "type": "https://sealpost.app/errors/insufficient_scope",
  "title": "Forbidden",
  "status": 403,
  "detail": "This key lacks the api_keys:write scope.",
  "code": "insufficient_scope",
  "request_id": "req_01J9ZK3V8Q4M2XQ7W0E5D1R6TA"
}

Headers

Sign-Request-Id

string

Unique id of this request (req_…). Quote it in support requests.

429

The key is over its per-minute budget (600 live, 60 test, sliding window).

application/problem+json

RFC 9457 problem details plus a stable code and the request_id.

object

type

required

https://sealpost.app/errors/{code}

string format: uri

title

required

string

status

required

integer

detail

Human-readable, safe to show to a developer, never contains secrets or signer data.

string

instance

The request path.

string

code

required

Stable machine-readable code from the catalogue (docs/errors.md).

string

request_id

required

string

errors

Field-level detail on validation_failed.

Array<object>

object

param

required

JSON pointer-ish path, e.g. scopes[2].

string

message

required

string

Example

{
  "type": "https://sealpost.app/errors/insufficient_scope",
  "title": "Forbidden",
  "status": 403,
  "detail": "This key lacks the api_keys:write scope.",
  "code": "insufficient_scope",
  "request_id": "req_01J9ZK3V8Q4M2XQ7W0E5D1R6TA"
}

Headers

Sign-Request-Id

string

Unique id of this request (req_…). Quote it in support requests.

Retry-After

integer

Seconds to wait before retrying.

RateLimit-Limit

integer

Requests allowed per minute for this key (600 live, 60 test).

RateLimit-Remaining

integer

Requests remaining in the current window.

RateLimit-Reset

integer

Seconds until the window has capacity again.

500

Something failed on our side. The request_id is in our logs.

application/problem+json

RFC 9457 problem details plus a stable code and the request_id.

object

type

required

https://sealpost.app/errors/{code}

string format: uri

title

required

string

status

required

integer

detail

Human-readable, safe to show to a developer, never contains secrets or signer data.

string

instance

The request path.

string

code

required

Stable machine-readable code from the catalogue (docs/errors.md).

string

request_id

required

string

errors

Field-level detail on validation_failed.

Array<object>

object

param

required

JSON pointer-ish path, e.g. scopes[2].

string

message

required

string

Example

{
  "type": "https://sealpost.app/errors/insufficient_scope",
  "title": "Forbidden",
  "status": 403,
  "detail": "This key lacks the api_keys:write scope.",
  "code": "insufficient_scope",
  "request_id": "req_01J9ZK3V8Q4M2XQ7W0E5D1R6TA"
}

Headers

Sign-Request-Id

string

Unique id of this request (req_…). Quote it in support requests.