Users

Get All Users with Expanded References

Returns all users that can be viewed by the authenticated user.

get/users?expand=1

Request

Headers

Accept'application/vnd.nexla.api.v1+json' | 'application/json'

Setting to application/vnd.nexla.api.v1+json is recommended.

Response

Success

idinteger
emailstring email
full_namestring
super_userboolean
impersonatedboolean
user_tier'FREE' | 'TRIAL' | 'PAID' | 'FREE_FOREVER'

Indicates whether a user is on a paid, free, or trial account. Used to determine limits on records processed by the account.

status'ACTIVE' | 'DEACTIVATED' | 'SOURCE_COUNT_CAPPED' | 'SOURCE_DATA_CAPPED' | 'TRIAL_EXPIRED'

Indicates the user's account status across all organizations they are members of.

account_lockedboolean
email_verified_atstring date-time
tos_signed_atstring date-time
updated_atstring date-time
created_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.