list_contacts
Retrieve a paginated list of contacts from your BoldSign organization to access signer details for document signing workflows, with options to filter by search terms and contact type.
Instructions
This tool allows you to retrieve a paginated list of contacts from your BoldSign organization. You can specify the page number to navigate through the results, the number of contacts to display per page, an optional search term to filter contacts, and the type of contacts to retrieve (your personal contacts or all organizational contacts). Contacts are primarily used to store signer details, identified by their unique email address, for use when creating and sending documents for signature within the BoldSign application.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| contactType | Yes | Optional. Filters the list of contacts based on their type. 'MyContacts' retrieves contacts specifically associated with your account, while 'AllContacts' (default) retrieves all accessible contacts within your organization. | AllContacts |
| page | Yes | ||
| pageSize | Yes | ||
| searchKey | No | Optional. A string used to filter the contact list. The API will return contacts whose details contain this search term. |
Input Schema (JSON Schema)
{
"properties": {
"contactType": {
"anyOf": [
{
"enum": [
"MyContacts",
"AllContacts"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "AllContacts",
"description": "Optional. Filters the list of contacts based on their type. 'MyContacts' retrieves contacts specifically associated with your account, while 'AllContacts' (default) retrieves all accessible contacts within your organization."
},
"page": {
"default": 1,
"maximum": 9007199254740991,
"minimum": 1,
"type": "integer"
},
"pageSize": {
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"searchKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional. A string used to filter the contact list. The API will return contacts whose details contain this search term."
}
},
"required": [
"pageSize",
"page",
"contactType"
],
"type": "object"
}