Description Usage Arguments Value
List users
1 2 3 4 5 6 7 8 9 10 11 12 |
feature_flag |
string optional. Return users that have a feature flag enabled. |
account_status |
string optional. The account status by which to filter users. May be one of "active", "inactive", or "all". |
query |
string optional. Return users who match the given query, based on name, user, and email. |
group_id |
integer optional. The ID of the group by which to filter users. Cannot be present if organization_id is. |
organization_id |
integer optional. The ID of the organization by which to filter users. Cannot be present if group_id is. |
exclude_groups |
boolean optional. Whether or to exclude users' groups. Default: false. |
limit |
integer optional. Number of results to return. Defaults to 20. Maximum allowed is 10000. |
page_num |
integer optional. Page number of the results to return. Defaults to the first page, 1. |
order |
string optional. The field on which to order the result set. Defaults to name. Must be one of: name, user. |
order_dir |
string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc. |
An array containing the following fields:
id |
integer, The ID of this user. |
user |
string, The username of this user. |
name |
string, The name of this user. |
email |
string, The email of this user. |
active |
boolean, The account status of this user. |
primaryGroupId |
integer, The ID of the primary group of this user. |
groups |
array, An array containing the following fields:
|
createdAt |
string, The date and time when the user was created. |
currentSignInAt |
string, The date and time when the user's current session began. |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.