List Users
gorgias_list_usersList Gorgias helpdesk users with cursor-based pagination. Filter by email, role, external ID, or search to retrieve specific user records.
Instructions
GET /api/users — List users with cursor-based pagination. Supports filtering by email, external ID, role, search term, and ordering.
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": "gorgias_list_users"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Filter by exact email address. | ||
| limit | No | Maximum number of users to return per page (default: 30, max: 100) | |
| roles | No | Filter by role names. Common values: 'admin', 'agent'. | |
| cursor | No | Pagination cursor from a previous response (meta.next_cursor or meta.prev_cursor) | |
| search | No | Free-text search against user name and email. | |
| order_by | No | Sort order, e.g. 'name:asc', 'email:desc', 'created_datetime:desc'. | |
| external_id | No | Filter by external_id (foreign system identifier). | |
| available_first | No | If true, prioritise currently available users in the result order. |