Skip to main content
POST
/
envelopes
List envelopes
curl --request POST \
  --url https://restapi.sign.plus/v2/envelopes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "search": "<string>",
  "tags": [
    "<string>"
  ],
  "comment": "<string>",
  "ids": [
    "<string>"
  ],
  "statuses": [],
  "folder_ids": [
    "<string>"
  ],
  "only_root_folder": true,
  "date_from": 123,
  "date_to": 123,
  "uid": "<string>",
  "first": 123,
  "last": 123,
  "after": "<string>",
  "before": "<string>",
  "ascending": true,
  "include_trash": true
}
'
import requests

url = "https://restapi.sign.plus/v2/envelopes"

payload = {
"name": "<string>",
"search": "<string>",
"tags": ["<string>"],
"comment": "<string>",
"ids": ["<string>"],
"statuses": [],
"folder_ids": ["<string>"],
"only_root_folder": True,
"date_from": 123,
"date_to": 123,
"uid": "<string>",
"first": 123,
"last": 123,
"after": "<string>",
"before": "<string>",
"ascending": True,
"include_trash": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
search: '<string>',
tags: ['<string>'],
comment: '<string>',
ids: ['<string>'],
statuses: [],
folder_ids: ['<string>'],
only_root_folder: true,
date_from: 123,
date_to: 123,
uid: '<string>',
first: 123,
last: 123,
after: '<string>',
before: '<string>',
ascending: true,
include_trash: true
})
};

fetch('https://restapi.sign.plus/v2/envelopes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://restapi.sign.plus/v2/envelopes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'search' => '<string>',
'tags' => [
'<string>'
],
'comment' => '<string>',
'ids' => [
'<string>'
],
'statuses' => [

],
'folder_ids' => [
'<string>'
],
'only_root_folder' => true,
'date_from' => 123,
'date_to' => 123,
'uid' => '<string>',
'first' => 123,
'last' => 123,
'after' => '<string>',
'before' => '<string>',
'ascending' => true,
'include_trash' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://restapi.sign.plus/v2/envelopes"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"search\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"ids\": [\n \"<string>\"\n ],\n \"statuses\": [],\n \"folder_ids\": [\n \"<string>\"\n ],\n \"only_root_folder\": true,\n \"date_from\": 123,\n \"date_to\": 123,\n \"uid\": \"<string>\",\n \"first\": 123,\n \"last\": 123,\n \"after\": \"<string>\",\n \"before\": \"<string>\",\n \"ascending\": true,\n \"include_trash\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://restapi.sign.plus/v2/envelopes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"search\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"ids\": [\n \"<string>\"\n ],\n \"statuses\": [],\n \"folder_ids\": [\n \"<string>\"\n ],\n \"only_root_folder\": true,\n \"date_from\": 123,\n \"date_to\": 123,\n \"uid\": \"<string>\",\n \"first\": 123,\n \"last\": 123,\n \"after\": \"<string>\",\n \"before\": \"<string>\",\n \"ascending\": true,\n \"include_trash\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://restapi.sign.plus/v2/envelopes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"search\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"ids\": [\n \"<string>\"\n ],\n \"statuses\": [],\n \"folder_ids\": [\n \"<string>\"\n ],\n \"only_root_folder\": true,\n \"date_from\": 123,\n \"date_to\": 123,\n \"uid\": \"<string>\",\n \"first\": 123,\n \"last\": 123,\n \"after\": \"<string>\",\n \"before\": \"<string>\",\n \"ascending\": true,\n \"include_trash\": true\n}"

response = http.request(request)
puts response.read_body
{
  "has_next_page": true,
  "has_previous_page": true,
  "envelopes": [
    {
      "id": "<string>",
      "name": "<string>",
      "comment": "<string>",
      "pages": 123,
      "created_at": 123,
      "updated_at": 123,
      "expires_at": 123,
      "num_recipients": 123,
      "is_duplicable": true,
      "signing_steps": [
        {
          "recipients": [
            {
              "name": "<string>",
              "email": "<string>",
              "id": "<string>",
              "uid": "<string>",
              "verification": {
                "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
      },
      "attachments": {
        "settings": {
          "visible_to_recipients": true
        },
        "recipients": [
          {
            "recipient_id": "<string>",
            "recipient_name": "<string>",
            "placeholders": [
              {
                "recipient_id": "<string>",
                "id": "<string>",
                "name": "<string>",
                "hint": "<string>",
                "required": true,
                "multiple": true,
                "files": [
                  {
                    "id": "<string>",
                    "name": "<string>",
                    "size": 123,
                    "mimetype": "<string>"
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
deprecated

Filter by envelope name. Deprecated — use search instead, which matches across envelope name, recipient name, and recipient email in a single query.

General-purpose search term that matches against envelope name, recipient name, and recipient email address. Case-insensitive and supports partial matches. Replaces the name field for broader, more flexible filtering.

tags
string[]

List of tags

Tag of the envelope

comment
string

Comment of the envelope

ids
string[]

List of envelope IDs

ID of the envelope

statuses
enum<string>[]

List of envelope statuses to filter by. Valid values: DRAFT, IN_PROGRESS, COMPLETED, EXPIRED, DECLINED, VOIDED, PENDING.

Available options:
DRAFT,
IN_PROGRESS,
COMPLETED,
EXPIRED,
DECLINED,
VOIDED,
PENDING
folder_ids
string[]

List of folder IDs

ID of the folder

only_root_folder
boolean

Whether to only list envelopes in the root folder

date_from
integer

Unix timestamp of the start date

date_to
integer

Unix timestamp of the end date

uid
string

Unique identifier of the user

first
integer
last
integer
after
string
before
string
order_field
enum<string>

Field to order envelopes by. Valid values: CREATION_DATE, MODIFICATION_DATE, NAME, STATUS, LAST_DOCUMENT_CHANGE.

Available options:
CREATION_DATE,
MODIFICATION_DATE,
NAME,
STATUS,
LAST_DOCUMENT_CHANGE
ascending
boolean

Whether to order envelopes in ascending order

include_trash
boolean

Whether to include envelopes in the trash

Response

200 - application/json

List of envelopes retrieved successfully

has_next_page
boolean

Whether there is a next page

has_previous_page
boolean

Whether there is a previous page

envelopes
object[]