Get all user's information.

  • Published on Sep 3, 2025
  • 1 minute(s) read
Prev Next
Get
/v1/users

Get user's information with status.

Security
API Key: bearerToken
Header parameter nameAuthentication

A JWT bearer token to be passed once authenticated.

Query parameters
all_search
string

Search on name or email.

limit
integer

Maximum numbers of users to return.

offset
integer

Number of users to skip from start.

sort_by
string

Sort fields. In the format of key1:ASC,key2:DESC,key3:DESC

Responses
200

Search result for user's objects.

Expand All
object
metadata
object (SearchMetadata)
page
integer

Current page number

pages
integer

Total pages as per the item counts and page limit.

limit
integer

Number of items to limit in a page.

total_count
integer

Total number of unfiltered items.

filtered_count
integer

Total number of items as per the current filter.

items
Array of object (User)
object
user_id
string (uuid)

User Id.

first_name
string

First Name.

last_name
string

Last Name.

user_email
string

User Email.

last_logged_in_at
integer (int64)

Last login time of user.

created_at
integer (int64)

Creation time of user.

email_verified
boolean

Whether this user's email has been verified.

status
string

Status of a user.

Valid values[ "ACTIVE", "PENDING", "DISABLED" ]
roles
Array of string (AccessRoles)
string

Roles of a user.

Valid values[ "READER", "WRITER", "MANAGER" ]
user_account_status
string

Status of an Account for a user.

Valid values[ "ACTIVE", "PENDING", "DISABLED" ]
accepted_latest_terms_and_conditions
boolean

Whether this user has accepted latest terms and conditions or not.

new_email
string

User’s new email address before it has been confirmed.