Users
List organization users
Returns a paginated list of users that belong to the organization the API key is scoped to, ordered by email. Optionally filters by a case-insensitive email substring match. Requires the workspace:read scope.
get/api/users
Query parameters
emailstring[]
Case-insensitive substrings to match against user emails (ILIKE). Repeat the parameter to filter by multiple emails; users matching any of them are returned.
[ "jane" ]
pagenumber
Example:1
1-based page number. Defaults to 1.
pageSizenumber
Example:20
Number of items per page (1-100). Defaults to 20.
Response
A page of users in the organization.
Example response
{
"results": [
{
"id": "a1b2c3d4-0000-0000-0000-000000000000",
"email": "jane@example.com"
}
],
"pagination": {
"totalPages": 5,
"currentPage": 1,
"totalCount": 92,
"pageSize": 20
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.