Skip to main content

List Users

List Users

Query Parameters
per_page number

Define the number of items per page, default is 100

page number

Define the page number, default is 1

term string

Search term, (login|email|activity)

role string

Filter by role values (MASTER|ADMIN|CUSTOMER)

role_type string

Filter by role type values (CUSTOMER|MASTER|MANAGER)

active boolean

Filter by active status

Responses
200

Successful response with list of users

Schema OPTIONAL
login string OPTIONAL

User login or email

name string OPTIONAL

User full name

phone string OPTIONAL

User phone number

activity string OPTIONAL

User activity/role

sector string OPTIONAL

User sector/department

last_request_at date-time OPTIONAL

Last request timestamp

active boolean OPTIONAL

Whether the user is active

roles object[] OPTIONAL

List of user roles

name string OPTIONAL

Role name or CUSTOM for custom roles

name_description string OPTIONAL

Role name description

type string OPTIONAL

Possible values: [ADMIN, MASTER, MANAGER, OPERATOR, CUSTOMER]

Role type

description string OPTIONAL

Role description

allowed_tenancy_ids number[] OPTIONAL

Departamentos em que o usuário tem acesso

menus object[] OPTIONAL

Menus that the user has access to

name string OPTIONAL

Menu name

name_description string OPTIONAL

Menu description

abilities string[] OPTIONAL

List of permissions for this menu