v1

latestSwagger 2.02026-07-134146194.6 MB
Users

Retrieves the list of users for the specified account. You can filter the users list to get specific users.

Retrieves the list of users for the specified account.

The response returns the list of users for the account, with information about the result set. If the additional_info query is added to the endpoint and set to true, full user information is returned for each user.

get/v2.1/accounts/{accountId}/users

Path parameters

accountIdstring required

(Required) The external account number (int) or account ID GUID.

Query parameters

additional_infostring

When true, the custom settings information is returned for each user in the account. If this parameter is omitted, the default behavior is false.

alternate_admins_onlystring

When true, returns only alternate administrators. These users are not administrators but will be set as such if all administrator memberships are closed. The default value is false.

countstring

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Valid values: 1 to 100

domain_users_onlystring

When true, return only users in domains claimed by your organization. The default value is false.

emailstring

Filters results based on the email address associated with the user that you want to return.

Note: You can use either this parameter or the email_substring parameter, but not both. For older accounts, this parameter might return multiple users who are associated with a single email address.

email_substringstring

Filters results based on a fragment of an email address. For example, you could enter gmail.com to return all users who have Gmail addresses.

Note: You do not use a wildcard character with this parameter. You can use either this parameter or the email parameter, but not both.

group_idstring

Filters results based on one or more group IDs.

include_licensestring
include_usersettings_for_csvstring

When true, the response includes the userSettings object data in CSV format.

login_statusstring

When true, the response includes the login status of each user.

not_group_idstring

Return user records excluding the specified group IDs.

start_positionstring

The zero-based index of the result from which to start returning results.

Use with count to limit the number of results.

The default value is 0.

statusstring

Filters results by user account status. A comma-separated list of any of the following:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled
user_name_substringstring

Filters the user records returned by the user name or a sub-string of user name.

Response

Successful response.