latestOpenAPI 3.0.42026-08-06124112344.5 KB

f23a94aea621

Users

Gets all users in an account.

get/users

Query parameters

idstring

Optional User Id to filter by

takeinteger

Optional number of items to return

pageinteger

Optional number of page to return

Response

Returns an array of users

idstring nullable

The user id

first_namestring nullable

The first name

last_namestring nullable

The last name

citystring nullable

The city

statestring nullable

The state

postal_codestring nullable

The postal code

countrystring nullable

The country

home_phonestring nullable

The home phone number

work_phonestring nullable

The work phone number

mobile_phonestring nullable

The mobile phone number

created_onstring date-time nullable

The date the user was created

emailstring nullable

The email address

rolestring[] nullable

The roles assigned to this user

user_namestring nullable

The username

last_activitystring date-time nullable

The date the user last logged in

email_alertsboolean nullable

Whether the user has email alerts enabled

sms_alertsboolean nullable

Whether the user has SMS alerts enabled

is_two_factorboolean nullable

Whether the user has two-factor authentication enabled