Organization Users
List organization users
Returns a list of the users in your organization.
get/organizations/users
Query parameters
page[number]integer
The page number to load
page[size]integer
The size of the page
filter[user_status]'enabled' | 'disabled' | 'blocked'
Filter by user status
filter[email]string
Filter by email address (partial match)
include_groupsboolean
When set to true, includes the groups array for each user in the response. The groups array contains objects with id and name for each group the user belongs to.
Response
Successful response with a list of organization users.
Example response
{
"data": [
{
"created_at": "2018-02-02T22:25:27.521Z",
"email": "user@example.com",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"last_sign_in_at": "2018-02-02T22:25:27.521Z",
"organization_user_bypasses_sso": false,
"record_type": "organization_sub_user",
"user_status": "enabled"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}