GET
/
envelope
/
{envelope_id}
/
annotations
curl --request GET \
  --url https://restapi.sign.plus/v2/envelope/{envelope_id}/annotations \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "recipient_id": "<string>",
    "document_id": "<string>",
    "page": 123,
    "x": 123,
    "y": 123,
    "width": 123,
    "height": 123,
    "required": true,
    "type": "TEXT",
    "signature": {
      "id": "<string>"
    },
    "initials": {
      "id": "<string>"
    },
    "text": {
      "size": 123,
      "color": 123,
      "value": "<string>",
      "tooltip": "<string>",
      "dynamic_field_name": "<string>",
      "font": {
        "family": "UNKNOWN",
        "italic": true,
        "bold": true
      }
    },
    "datetime": {
      "size": 123,
      "font": {
        "family": "UNKNOWN",
        "italic": true,
        "bold": true
      },
      "color": "<string>",
      "auto_fill": true,
      "timezone": "<string>",
      "timestamp": 123,
      "format": "DMY_NUMERIC_SLASH"
    },
    "checkbox": {
      "checked": true,
      "style": "CIRCLE_CHECK"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
envelope_id
string
required

ID of the envelope

Response

200 - application/json
List of annotations retrieved successfully
​
id
string

Unique identifier of the annotation

​
recipient_id
string

ID of the recipient

​
document_id
string

ID of the document

​
page
integer

Page number where the annotation is placed

​
x
number

X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner

​
y
number

Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner

​
width
number

Width of the annotation (in % of the page width from 0 to 100)

​
height
number

Height of the annotation (in % of the page height from 0 to 100)

​
required
boolean

Whether the annotation is required

​
type
enum<string>

Type of the annotation

Available options:
TEXT,
SIGNATURE,
INITIALS,
CHECKBOX,
DATE
​
signature
object

Signature annotation (null if annotation is not a signature)

​
initials
object

Initials annotation (null if annotation is not initials)

​
text
object

Text annotation (null if annotation is not a text)

​
datetime
object

Date annotation (null if annotation is not a date)

​
checkbox
object

Checkbox annotation (null if annotation is not a checkbox)