list_documents

Retrieve and manage a paginated list of documents with details like status, sender, recipient, and creation date. Filter by search terms, sender, recipient, labels, or date ranges for efficient document navigation.

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`	No	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`	No	Required. The page number to retrieve, starting from 1. Used for pagination to navigate through the list of available documents.
`pageSize`	No	Optional. The maximum number of documents to display per page. Defaults to 10 but can be set between 1 and 100.
`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`	No	Optional. Filter documents based on their current status. Available statuses include 'WaitingForMe', 'WaitingForOthers', 'NeedAttention', 'Completed', 'Declined', 'Revoked', 'Expired', 'Scheduled', and 'Draft'. Use 'None' to disable status filtering.
`transmitType`	No	Optional. Type of transmission. Can be 'Sent', 'Received', or 'Both'.	Both

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "brandIds": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "items": {
                "description": "Unique identifier (ID) of the brand.",
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional. Filters documents based on associated brand IDs. Only documents linked to the specified brands will be retrieved."
    },
    "dateFilterType": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "enum": [
                "SentBetween",
                "Expiring"
              ],
              "type": "string"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional. Type of date filter applied to documents. Available options: 'SentBetween' and 'Expiring'."
    },
    "endDate": {
      "anyOf": [
        {
          "$ref": "#/properties/startDate/anyOf/0"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional. End transmit date range of the document. The date should be in a valid date-time format."
    },
    "labels": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "items": {
                "description": "Label of the document.",
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional. Labels associated with documents. Used to filter the list by specific document tags."
    },
    "nextCursor": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "type": "number"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional. Cursor value for pagination beyond 10,000 records. Set to the cursor of the last retrieved document."
    },
    "page": {
      "default": 1,
      "description": "Required. The page number to retrieve, starting from 1. Used for pagination to navigate through the list of available documents.",
      "minimum": 1,
      "type": "integer"
    },
    "pageSize": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "default": 10,
      "description": "Optional. The maximum number of documents to display per page. Defaults to 10 but can be set between 1 and 100."
    },
    "recipients": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "items": {
                "description": "Email address of the signer.",
                "format": "email",
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional. Filter documents by signer email addresses. One or more signer email IDs can be specified."
    },
    "searchKey": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "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": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "items": {
                "description": "Email address of the sender.",
                "format": "email",
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional. Filter documents by sender email addresses. One or more sender email IDs can be specified."
    },
    "startDate": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "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": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "items": {
                "default": "None",
                "enum": [
                  "None",
                  "WaitingForMe",
                  "WaitingForOthers",
                  "NeedAttention",
                  "Completed",
                  "Declined",
                  "Revoked",
                  "Expired",
                  "Scheduled",
                  "Draft"
                ],
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional. Filter documents based on their current status. Available statuses include 'WaitingForMe', 'WaitingForOthers', 'NeedAttention', 'Completed', 'Declined', 'Revoked', 'Expired', 'Scheduled', and 'Draft'. Use 'None' to disable status filtering."
    },
    "transmitType": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "enum": [
                "Sent",
                "Received",
                "Both"
              ],
              "type": "string"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "default": "Both",
      "description": "Optional. Type of transmission. Can be 'Sent', 'Received', or 'Both'."
    }
  },
  "type": "object"
}

boldsign

list_documents

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from boldsign

Related Tools