list_team_documents

Retrieve and filter a paginated list of team documents in BoldSign by status, user ID, team ID, date range, or document details. Admins access sent and received documents across the organization.

Instructions

Retrieve a paginated list of documents available in the Team Documents section of your BoldSign organization. Team admins can view documents sent and received by team members, while account admins have access to all team documents across the organization. This API allows filtering based on status, user ID, team ID, document details, transmission type, and date range. If the user is not an account admin or team admin, an unauthorized response will be returned.

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 team documents.
`pageSize`	No	Optional. The maximum number of team documents to display per page. Defaults to 10 but can be set between 1 and 100.
`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.
`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.
`teamId`	No	Optional. Filter documents based on specific teams. One or more team IDs can be specified.
`transmitType`	No	Optional. Type of transmission. Can be 'Sent', 'Received', or 'Both'.	Both
`userId`	No	Optional. Filter documents based on the list of team member IDs. One or more user IDs can be specified.

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 team 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 team documents to display per page. Defaults to 10 but can be set between 1 and 100."
    },
    "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."
    },
    "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."
    },
    "teamId": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "items": {
                "description": "The unique identifier (ID) of the team.",
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional. Filter documents based on specific teams. One or more team IDs can be specified."
    },
    "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'."
    },
    "userId": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "items": {
                "description": "The unique identifier (ID) of a user in the team.",
                "type": "string"
              },
              "type": "array"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional. Filter documents based on the list of team member IDs. One or more user IDs can be specified."
    }
  },
  "type": "object"
}

boldsign