list_teams
Retrieve a paginated list of teams within your BoldSign organization to view team details including members, creation dates, and modification dates with search filtering capabilities.
Instructions
Retrieve a paginated list of teams within your BoldSign organization. This API fetches team details such as team name, users, created date, and modified date for all listed teams, with options for filtering using a search term and navigating through pages of results.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | ||
| pageSize | Yes | ||
| searchKey | No | Optional. A search term to filter the list of teams. The API will return teams whose details, such as name, match the provided search term. |
Input Schema (JSON Schema)
{
"properties": {
"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 search term to filter the list of teams. The API will return teams whose details, such as name, match the provided search term."
}
},
"required": [
"pageSize",
"page"
],
"type": "object"
}