Envelope
Get envelope annotations
Get Started
Guides
- Account
- Envelopes
- Templates
- Webhooks
Backend SDKs
- Python
- Typescript
- Go
- Java
- C#
- PHP
API Reference
- Envelope
- POSTCreate new envelope
- POSTCreate new envelope from template
- POSTList envelopes
- GETGet envelope
- DELDelete envelope
- GETGet envelope document
- GETGet envelope documents
- POSTAdd envelope document
- PUTSet envelope dynamic fields
- POSTAdd envelope signing steps
- POSTSend envelope for signature
- POSTDuplicate envelope
- PUTVoid envelope
- PUTRename envelope
- PUTSet envelope comment
- PUTSet envelope notification
- PUTSet envelope expiration date
- PUTSet envelope legality level
- GETGet envelope annotations
- GETGet envelope document annotations
- POSTAdd envelope annotation
- DELDelete envelope annotation
- GETDownload signed documents
- GETDownload certificate of completion
- POST
- Template
- Webhook
Envelope
Get envelope annotations
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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the envelope
Response
200 - application/json
List of annotations retrieved successfully
The response is of type object[]
.
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"
}
}
]