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
             [
    {
        "account_title": "string",
        "address": {
            "id": 0,
            "zip": "string",
            "city": "string",
            "country": 0,
            "province": 0,
            "address": "string",
            "selected": true
        },
        "creation_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
        "date_of_birth": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "logo_url": "string",
        "owner_ship": 1.01,
        "phone": "string",
        "role": "ACCOUNT_OWNER",
        "ssn": "string",
        "state": "ACTIVE",
        "user_code": "string"
    }
]
             
          
{ } UserResponseV2Model
account_title (optional) string
address (optional) AddressApiV2Model
creation_date (optional) string
date_of_birth (optional) string
email (optional) string
first_name (optional) string
last_name (optional) string
logo_url (optional) string
owner_ship (optional) number
phone (optional) string
role (optional) string
ssn (optional) string
state (optional) string
user_code (optional) string
{ } AddressApiV2Model
id (optional) integer
zip (optional) string
city (optional) string
country (optional) integer
province (optional) integer
address (optional) string
selected (optional) boolean
             <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>
    <account_title>string</account_title>
    <address/>
    <creation_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</creation_date>
    <date_of_birth>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</date_of_birth>
    <email>string</email>
    <first_name>string</first_name>
    <last_name>string</last_name>
    <logo_url>string</logo_url>
    <owner_ship>1.01</owner_ship>
    <phone>string</phone>
    <role>ACCOUNT_OWNER</role>
    <ssn>string</ssn>
    <state>ACTIVE</state>
    <user_code>string</user_code>
  </user_response_model>
</user_response_models>

             
          
{ } UserResponseV2Model
account_title (optional) string
address (optional) AddressApiV2Model
creation_date (optional) string
date_of_birth (optional) string
email (optional) string
first_name (optional) string
last_name (optional) string
logo_url (optional) string
owner_ship (optional) number
phone (optional) string
role (optional) string
ssn (optional) string
state (optional) string
user_code (optional) string
{ } AddressApiV2Model
id (optional) integer
zip (optional) string
city (optional) string
country (optional) integer
province (optional) integer
address (optional) string
selected (optional) boolean