list_users
Retrieve a paginated list of BoldSign users, with optional filtering by a search term, to manage and navigate user data efficiently.
Instructions
Retrieves a paginated list of BoldSign users, with optional filtering by a search term.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Required. The page number of the user list to retrieve. Used for pagination to navigate through the list of available users. | |
| pageSize | No | Optional. Specifies the maximum number of user records to be retrieved per page. If not provided, a default page size will be used by the BoldSign API. The value must be between 1 and 100. The default value is 10. | |
| search | No | Optional. A string used to filter the user list. The API will return contacts whose details contain this search term. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"page": {
"default": 1,
"description": "Required. The page number of the user list to retrieve. Used for pagination to navigate through the list of available users.",
"minimum": 1,
"type": "integer"
},
"pageSize": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"maximum": 100,
"minimum": 1,
"type": "integer"
}
]
},
{
"type": "null"
}
],
"default": 10,
"description": "Optional. Specifies the maximum number of user records to be retrieved per page. If not provided, a default page size will be used by the BoldSign API. The value must be between 1 and 100. The default value is 10."
},
"search": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Optional. A string used to filter the user list. The API will return contacts whose details contain this search term."
}
},
"type": "object"
}