Get All Users
users_get_allRetrieve registered user accounts in the organization. Specify fields and pagination to get only the details you need.
Instructions
Get information about user accounts registered in the organization.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "users_get_all"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number to return, default is 1 | |
| fields | No | Fields to include in each user; omit to get all. Select only what you need. | |
| per_page | No | The number of items per page. May be decreased if results exceed context window. If there is a change in per_page argument - retrieval must be started over with page = 1, as the paging could have changed. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hits | No | Total items matching the request, across all pages. Null if unknown or filtered - then page on until a page comes back empty. | |
| pages | No | Total pages at the requested `per_page`; this is the last page when it equals `page`. Null together with `hits`. | |
| values | No |