list_users
Retrieve team users visible to your API key, excluding disabled accounts unless specified. Filter by name/email and paginate results.
Instructions
List the users this API key can see, which is the whole team. Disabled users are left out unless asked for.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many objects to return. Upstream maximum is 1000. | |
| query | No | Keep only users whose name or email contains this text. | |
| offset | No | How many objects to skip, for the next page. | |
| include_disabled | No | Include users who have been disabled. Defaults to false. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | Set when the answer is worth a word of explanation. | |
| count | Yes | How many objects match the filters upstream, beyond this page. | |
| items | Yes | The objects. | |
| returned | Yes | How many objects this answer carries. |