Retrieve a list of users and their details

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Allows advanced filtering using the function-based DSL. For more information please visit https://developers.unify-retail.com/docs/filtering

Allowed field(s)/operator(s):

user_id : equals, not-equals, any, none, is-null

email : equals, not-equals, contains, starts-with, ends-with, any, none, is-null, is-empty, is-not-empty

first_name, last_name : equals, not-equals, contains, starts-with, ends-with, any, none, is-null

status : equals, not-equals, any, none, is-null

oms_access, admin_access : equals, not-equals, is-null

profile_id : equals, not-equals, any, none, is-null

created_at, updated_at : equals, less-than, less-or-equal, greater-than, greater-or-equal, is-null

integer
≥ 1
Defaults to 1

Page number to retrieve. Default: 1

integer
1 to 1000
Defaults to 50

Number of records to return per page. Default: 50. Maximum: 1000

string
deprecated

List of seller codes (separated by commas)

Deprecated - use filter=any(user_id,["U1","U2"]) instead.

string
deprecated

User first name

Deprecated - use filter=contains(first_name,"John") instead.

string
deprecated

User last name

Deprecated - use filter=contains(last_name,"Doe") instead.

string
deprecated

User email

Deprecated - use filter=contains(email,"@example.com") instead.

integer
enum
deprecated

Indicates whether the user has OMS access

Deprecated - use filter=equals(oms_access,1) instead.

Allowed:
integer
enum
deprecated

Indicates whether the user has admin access

Deprecated - use filter=equals(admin_access,1) instead.

Allowed:
string
enum
deprecated

User status

Deprecated - use filter=equals(status,"active") instead.

Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json