Skip to main content
GET
GET /v1/users

List Users

List all users with optional filtering and pagination.

Query Parameters

integer
default:"10"
Maximum number of results to return (max: 1000000).
string
Cursor for backward pagination.
string
Cursor for forward pagination.
string
Comma-separated list of fields to include: teams, roles, personas, domains, follows, owns. See Supported Fields below.
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
boolean
Filter by bot status. Set to true to list only bot accounts, false for human users only.
boolean
Filter by admin status. Set to true to list only admin users.
string
Filter by team name. Returns only users belonging to the specified team.
GET /v1/users

Returns

Returns a paginated list of user objects. By default, only basic fields are included. Use the fields parameter to request additional data.

Response

array
Array of user objects.
object
Pagination information.

Supported Fields

The following fields can be requested via the fields query parameter:

Error Handling