Retrieve a list of users

Retrieve a list of users.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

q
string

Use this field to perform a partial search of text fields.

Responses
200

List of users retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
email
required
string <email> <= 100 characters

Email address of the user.

firstName
required
string

User's first name.

lastName
required
string

User's last name.

id
string <= 50 characters

ID of the user.

businessPhone
string

User's business phone number.

mobilePhone
string

User's mobile phone number.

password
string <password>

User's password. If this value is not provided, a password reset email is sent.

permissions
Array of strings <operationId>

Permissions that the user has within organizations. Use the wildcard character * for full access.

computedPermissions
Array of strings <operationId>

All user permissions and roles. Use these permissions to emulate the user.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

loginTime
string <date-time>

Date and time when the user last logged in.

reportingCurrency
string

User's currency code in ISO 4217 format. This value is used for reports.

availableCurrencies
Array of strings

Array of reporting currencies that are enabled for the merchant.

totpRequired
boolean

Specifies whether two-factor authentification is enabled for the user.

totpSecret
string

User's Time-based One-Time Password (TOTP) key for the authentification application, if TOTP is enabled..

totpUrl
string <url>

QR-code link that redirects the user to the authentification application, if TOTP is enabled.

status
string

Status of the user's account.

Enum: "active" "inactive" "pending-confirmation"
country
string

User's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.

preferences
object

User preferences, such as: timezone, language, and more. This is an object with custom properties.

roleIds
Array of strings

Role IDs associated with the user. Role IDs specify the roles that the user performs within the organization. For example, the user may be an organization admin.

allowedIps
Array of strings or null <ip> (AllowedIps)

List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to null.

Array of objects (Self) non-empty

Related links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/users
Request samples
$users = $client->users()->search([
    'filter' => 'firstName:John',
]);
Response samples
application/json
[
  • {
    }
]