Envelope
List envelopes
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
List envelopes
POST
/
envelopes
curl --request POST \
--url https://restapi.sign.plus/v2/envelopes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"tags": [
"<string>"
],
"comment": "<string>",
"ids": [
"<string>"
],
"statuses": [
"DRAFT"
],
"folder_ids": [
"<string>"
],
"only_root_folder": true,
"date_from": 123,
"date_to": 123,
"uid": "<string>",
"first": 123,
"last": 123,
"after": "<string>",
"before": "<string>",
"order_field": "CREATION_DATE",
"ascending": true,
"include_trash": true
}'
{
"has_next_page": true,
"has_previous_page": true,
"envelopes": [
{
"id": "<string>",
"name": "<string>",
"comment": "<string>",
"pages": 123,
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"status": "DRAFT",
"created_at": 123,
"updated_at": 123,
"expires_at": 123,
"num_recipients": 123,
"is_duplicable": true,
"signing_steps": [
{
"recipients": [
{
"id": "<string>",
"uid": "<string>",
"name": "<string>",
"email": "<string>",
"role": "SIGNER",
"verification": {
"type": "SMS",
"value": "<string>"
}
}
]
}
],
"documents": [
{
"id": "<string>",
"name": "<string>",
"filename": "<string>",
"page_count": 123,
"pages": [
{
"width": 123,
"height": 123
}
]
}
],
"notification": {
"subject": "<string>",
"message": "<string>",
"reminder_interval": 123
}
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200 - application/json
List of envelopes retrieved successfully
The response is of type object
.
curl --request POST \
--url https://restapi.sign.plus/v2/envelopes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"tags": [
"<string>"
],
"comment": "<string>",
"ids": [
"<string>"
],
"statuses": [
"DRAFT"
],
"folder_ids": [
"<string>"
],
"only_root_folder": true,
"date_from": 123,
"date_to": 123,
"uid": "<string>",
"first": 123,
"last": 123,
"after": "<string>",
"before": "<string>",
"order_field": "CREATION_DATE",
"ascending": true,
"include_trash": true
}'
{
"has_next_page": true,
"has_previous_page": true,
"envelopes": [
{
"id": "<string>",
"name": "<string>",
"comment": "<string>",
"pages": 123,
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"status": "DRAFT",
"created_at": 123,
"updated_at": 123,
"expires_at": 123,
"num_recipients": 123,
"is_duplicable": true,
"signing_steps": [
{
"recipients": [
{
"id": "<string>",
"uid": "<string>",
"name": "<string>",
"email": "<string>",
"role": "SIGNER",
"verification": {
"type": "SMS",
"value": "<string>"
}
}
]
}
],
"documents": [
{
"id": "<string>",
"name": "<string>",
"filename": "<string>",
"page_count": 123,
"pages": [
{
"width": 123,
"height": 123
}
]
}
],
"notification": {
"subject": "<string>",
"message": "<string>",
"reminder_interval": 123
}
}
]
}