Envelope List

Server URLloading...

GET

/signatures/envelope/list

Send

Authorization

Query

Retrieves a list of all envelopes associated with the authenticated user, including those created/sent by the user and those where the user is a recipient.

• Supports filtering, sorting, and pagination via query parameters to help developers query specific envelopes.
• Query Parameters:
  • top (integer). Maximum number of envelopes to return (e.g., 25).
  • skip (integer). Number of envelopes to skip in the sorted results (e.g., 0).
  • sort (string). Column to sort by. Valid values: Subject, Recipients, Documents, Status, UploadDate, ExpireInDays.
  • order (string). Sort direction. Valid values: ASC, DESC.
  • folder (string). Folder to query. Valid values: Inbox, Sent, Drafts, Deleted, Action Required, Expiring Soon, Waiting for Others, Completed.
  • filter (JSON array). List of filter objects to refine results. Each filter includes:
    • column (string). Field to filter on (matches sort values).
    • condition (string). Filter condition:
      • For stringFilter: EMPTY, NOT_EMPTY, CONTAINS, CONTAINS_CASE_SENSITIVE, DOES_NOT_CONTAIN, DOES_NOT_CONTAIN_CASE_SENSITIVE, STARTS_WITH, STARTS_WITH_CASE_SENSITIVE, ENDS_WITH, ENDS_WITH_CASE_SENSITIVE, EQUAL, EQUAL_CASE_SENSITIVE, NULL, NOT_NULL.
      • For dateFilter: EQUAL, NOT_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL, NULL, NOT_NULL.
    • value (string). Filter value:
      • string for stringFilter.
      • YYYY-MM-DD for dateFilter.
    • type (string):
      • Either stringFilter.
      • dateFilter.
    • key (string). Unique 12-character alphanumeric identifier for the filter.

Filter example: envelope/list?$top=25&$skip=0&$sort=Subject&$order=ASC&$filter=[{"column":"status","condition":"CONTAINS","value":"Failed","type":"stringFilter","key":"6e2d9f910ad9"},{"column":"uploadDate","condition":"EQUAL","value":"2025-06-30","type":"dateFilter","key":"068d7e1baf7d"}]&$folder=Inbox Note: sort/order are documented here as two separate params for developer convenience, but the server actually reads a single combined orderby="|" query parameter - see the orderby parameter description. The folder values below are read via a filter[] entry with key="folder", there is no separate folder= query parameter.

Query Parameters

Response Body

curl -X GET "https://example.com/signatures/envelope/list"

{  "result": {    "statusCode": 200,    "message": "OK",    "data": {      "envelopes": [        {          "id": "string",          "createdBy": {            "id": "string",            "name": "string",            "email": "string"          },          "creatorGuid": "string",          "status": "string",          "uploadDate": "string",          "sendDate": "string",          "subject": "string",          "transactionTokenId": "string",          "documents": "string",          "recipients": "string",          "signGroups": "string",          "isSignOrder": true,          "recipientStatus": "string",          "expireInDays": 0,          "alertDaysBeforeExpiry": 0        }      ],      "rowCount": 0    }  },  "origin": "string",  "dateTime": "string"}

{  "error": {    "message": "Envelope not found.",    "statusCode": 400,    "innerErrors": [      {        "code": "ENVELOPE_ID_INVALID",        "message": "Envelope not found.",        "userMessage": "Envelope not found."      }    ]  },  "origin": "POST https://apim-mavenheadless-dev-westeu-1.azure-api.net/v1/signatures/envelope/create",  "dateTime": "2026-07-20T12:00:00.0000000+00:00"}

{  "error": {    "message": "Envelope not found.",    "statusCode": 400,    "innerErrors": [      {        "code": "ENVELOPE_ID_INVALID",        "message": "Envelope not found.",        "userMessage": "Envelope not found."      }    ]  },  "origin": "POST https://apim-mavenheadless-dev-westeu-1.azure-api.net/v1/signatures/envelope/create",  "dateTime": "2026-07-20T12:00:00.0000000+00:00"}