v1
latestOpenAPI 3.1.12026-07-2692827.1 KBUsers
List users and their permissions
List every user in the account along with their permissions. Restricted to account admins: if the API key does not belong to a user whose settings_access level is account_admin, this endpoint returns 403 Forbidden.
By default the list contains active and deactivated members followed by pending invitees — keep following next_cursor to page through all of them. Use status to narrow to one group. Invited users have no permissions yet, so their items omit the permissions object and created_at is the date they were invited.
get/users
Query parameters
cursorstring
Cursor for pagination.
teamstring
Team name to filter by.
status'active' | 'deactivated' | 'invited'
Filter by user status. invited cannot be combined with settings_access.
settings_access'none' | 'team_admin' | 'account_admin'
Filter by settings access level.
Response
Paginated list of users.
Example response
{
"items": [
{
"name": "Bob Lee",
"email": "bob.lee@acme.com",
"created_at": "2024-06-01T08:30:00Z",
"permissions": {
"settings_access": {
"teams": [
"Sales",
"Customer Success"
]
},
"view_access": {
"teams": [
"Sales"
]
}
}
}
]
}