NAV

getUsers

POST /v2/user/list

Use this API call to retrieve a list of users available for a particular company.

Parameters
Name
Description
userListFilterV2Model (required)

This model allows you to specify how data should be returned in the result that it is filtered. For more details, please follow the body schema as described in the details of this call.

Response Messages
Code
Description
200
OK
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
             {
    "first": 0,
    "count": 0,
    "date_from": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "date_to": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "filter_type": "ACTIVE",
    "search": "string",
    "sort": "ROLE",
    "ascending": true
}
             
          
{ } UserListFilterV2Model
first (optional) integer
count (optional) integer
date_from (optional) string
date_to (optional) string
filter_type (optional) string
search (optional) string
sort (optional) string
ascending (optional) boolean
             [
    {
        "creation_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "logo_url": "string",
        "phone": "string",
        "role": "ACCOUNT_OWNER",
        "state": "ACTIVE",
        "user_code": "string"
    }
]
             
          
{ } UserResponseV2Model
creation_date (optional) string
email (optional) string
first_name (optional) string
last_name (optional) string
logo_url (optional) string
phone (optional) string
role (optional) string
state (optional) string
user_code (optional) string
             <user_list_filter_model>
  <first>0</first>
  <count>0</count>
  <date_from>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</date_from>
  <date_to>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</date_to>
  <filter_type>ACTIVE</filter_type>
  <search>string</search>
  <sort>ROLE</sort>
  <ascending>1</ascending>
</user_list_filter_model>

             
          
{ } UserListFilterV2Model
first (optional) integer
count (optional) integer
date_from (optional) string
date_to (optional) string
filter_type (optional) string
search (optional) string
sort (optional) string
ascending (optional) boolean
             <user_response_models>
  <user_response_model>
    <creation_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</creation_date>
    <email>string</email>
    <first_name>string</first_name>
    <last_name>string</last_name>
    <logo_url>string</logo_url>
    <phone>string</phone>
    <role>ACCOUNT_OWNER</role>
    <state>ACTIVE</state>
    <user_code>string</user_code>
  </user_response_model>
</user_response_models>

             
          
{ } UserResponseV2Model
creation_date (optional) string
email (optional) string
first_name (optional) string
last_name (optional) string
logo_url (optional) string
phone (optional) string
role (optional) string
state (optional) string
user_code (optional) string