Envelopes

List structured envelope fields

Returns every field in document order: page, vertical position, horizontal position, then public id. Unlike create requests and nested signer fields, page is a one-based page number. The endpoint is available in every envelope status.

Named and unnamed fields are both returned. Signature and initials image bytes stay private. A filled image field carries a credential-authenticated signature.url; send the same bearer credential when following it. The URL itself does not expire, so expiresAt is null, but every read rechecks credential and workspace access. An envelope in another workspace answers 404.

get/envelopes/{envelopeId}/fields

Request

  • Base URL: https://inkseal.net/api/v1
  • URL: https://inkseal.net/api/v1/envelopes/{envelopeId}/fields
  • Auth: HTTP bearer

Response

The envelope's structured fields in deterministic document order.

Example response

{
  "data": [
    {
      "type": "signature"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.