Docusign · Schema

EnvelopesInformation

Contains information about the envelopes returned by a list request, including the result set and pagination details.

AgreementsContractsDigital Transaction ManagementDocumentsElectronic SignatureseSignature

Properties

Name	Type	Description
envelopes	array	The list of envelopes matching the query.
resultSetSize	string	The number of results in the current set.
totalSetSize	string	The total number of envelopes matching the query.
startPosition	string	The starting index position of the current result set.
endPosition	string	The ending index position of the current result set.
nextUri	string	URI for the next page of results.
previousUri	string	URI for the previous page of results.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EnvelopesInformation",
  "type": "object",
  "description": "Contains information about the envelopes returned by a list request, including the result set and pagination details.",
  "properties": {
    "envelopes": {
      "type": "array",
      "description": "The list of envelopes matching the query."
    },
    "resultSetSize": {
      "type": "string",
      "description": "The number of results in the current set."
    },
    "totalSetSize": {
      "type": "string",
      "description": "The total number of envelopes matching the query."
    },
    "startPosition": {
      "type": "string",
      "description": "The starting index position of the current result set."
    },
    "endPosition": {
      "type": "string",
      "description": "The ending index position of the current result set."
    },
    "nextUri": {
      "type": "string",
      "description": "URI for the next page of results."
    },
    "previousUri": {
      "type": "string",
      "description": "URI for the previous page of results."
    }
  }
}