Users: list

Retrieves the list of users for the specified account.

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

Request

HTTP request

GET /v2/accounts/{accountId}/users

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

Optional Query Parameters
additional_infostring

When set to true, the full list of user information is returned for each user in the account.

countstring

Number of records to return. The number must be greater than 0 and less than or equal to 100.

emailstring

email_substringstring

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

group_idstring

Filters user records returned by one or more group Id's.

login_statusstring

not_group_idstring

start_positionstring

Starting value for the list.

statusstring

Filters the results by user status. You can specify a comma-separated list of the following statuses:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

user_name_substringstring

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

Responses

CodeDescriptionReference
200

Successful response.

userInformationList
400

Error encountered.

errorDetails

SDK Method

Users::list

Definitions

addressInformation_v2
errorDetails
forgottenPasswordInformation
group
nameValue
settingsMetadata
userAccountManagementGranularInformation
userInfo
userInformationList
Users

Examples

Generic JSON Response
Generic XML Response