list_documents
Retrieve and filter documents from your My Documents section with pagination, search, and filtering by status, sender, recipient, date range, and labels.
Instructions
Retrieve a paginated list of documents available in your My Documents section. This API fetches document details such as status, sender, recipient, labels, transmission type, creation date, and modification date, with options for filtering and paginated navigation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| brandIds | No | Optional. Filters documents based on associated brand IDs. Only documents linked to the specified brands will be retrieved. | |
| dateFilterType | No | Optional. Type of date filter applied to documents. Available options: 'SentBetween' and 'Expiring'. | |
| endDate | No | Optional. End transmit date range of the document. The date should be in a valid date-time format. | |
| labels | Yes | Optional. Labels associated with documents. Used to filter the list by specific document tags. | |
| nextCursor | No | Optional. Cursor value for pagination beyond 10,000 records. Set to the cursor of the last retrieved document. | |
| page | Yes | ||
| pageSize | Yes | ||
| recipients | No | Optional. Filter documents by signer email addresses. One or more signer email IDs can be specified. | |
| searchKey | No | Optional. A search term used to filter the document list. The API will return documents matching details like document title, document ID, sender name, or recipient name. | |
| sentBy | No | Optional. Filter documents by sender email addresses. One or more sender email IDs can be specified. | |
| startDate | No | Optional. Start transmit date range of the document. The date should be in a valid date-time format. | |
| status | Yes | Optional. Filter documents based on their current status. | |
| transmitType | Yes | Optional. Type of transmission to filter documents if the user is both sender, recipient or both. | Both |
Input Schema (JSON Schema)
{
"properties": {
"brandIds": {
"description": "Optional. Filters documents based on associated brand IDs. Only documents linked to the specified brands will be retrieved.",
"items": {
"description": "Unique identifier (ID) of the brand.",
"type": "string"
},
"type": "array"
},
"dateFilterType": {
"description": "Optional. Type of date filter applied to documents. Available options: 'SentBetween' and 'Expiring'.",
"enum": [
"SentBetween",
"Expiring"
],
"type": "string"
},
"endDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional. End transmit date range of the document. The date should be in a valid date-time format."
},
"labels": {
"default": [],
"description": "Optional. Labels associated with documents. Used to filter the list by specific document tags.",
"items": {
"description": "Label of the document.",
"type": "string"
},
"type": "array"
},
"nextCursor": {
"description": "Optional. Cursor value for pagination beyond 10,000 records. Set to the cursor of the last retrieved document.",
"type": "number"
},
"page": {
"default": 1,
"maximum": 9007199254740991,
"minimum": 1,
"type": "integer"
},
"pageSize": {
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"recipients": {
"description": "Optional. Filter documents by signer email addresses. One or more signer email IDs can be specified.",
"items": {
"description": "Email address of the signer.",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"type": "string"
},
"type": "array"
},
"searchKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional. A search term used to filter the document list. The API will return documents matching details like document title, document ID, sender name, or recipient name."
},
"sentBy": {
"description": "Optional. Filter documents by sender email addresses. One or more sender email IDs can be specified.",
"items": {
"description": "Email address of the sender.",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"type": "string"
},
"type": "array"
},
"startDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional. Start transmit date range of the document. The date should be in a valid date-time format."
},
"status": {
"default": [],
"description": "Optional. Filter documents based on their current status.",
"items": {
"default": "None",
"enum": [
"None",
"WaitingForMe",
"WaitingForOthers",
"NeedAttention",
"Completed",
"Declined",
"Revoked",
"Expired",
"Scheduled",
"Draft"
],
"type": "string"
},
"type": "array"
},
"transmitType": {
"default": "Both",
"description": "Optional. Type of transmission to filter documents if the user is both sender, recipient or both.",
"enum": [
"Sent",
"Received",
"Both"
],
"type": "string"
}
},
"required": [
"pageSize",
"page",
"labels",
"transmitType",
"status"
],
"type": "object"
}