Retrieves all users

Request Information

URI Parameters :

None.

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

user
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier

Required
db_language_id

Foreign key of db_language

 globally unique identifier
username

Username of the user, normally his email address

 string

Required

Max length: 255
firstname

Firstname of the user

 string

Max length: 255
lastname

Lastname of the user

 string

Required

Max length: 255
code

The Id/Ref of the back office. Used by Embedded entity

 string

Max length: 50
archived

Archive the user if he is not valid anymore (user cannot be deleted)

 boolean
disabled

Disable temporaly the user (cannot log on)

 boolean
emergency_contact

HR : Person to contact in case of emergency (wife,husband)

 string

Max length: 64
bankaccount

HR : Bank Account

 string

Max length: 50
social_security

HR : Social Security Number

 string

Max length: 50
place_of_birth

HR : place of birth

 string

Max length: 255
nationality

HR : nationality of the user

 string

Max length: 255
functions

HR : Functions of the user (Manager, Tech leader)

 string

Max length: 255
birthdate

HR : Birthdate of the user

 date
skype

Skype name

 string

Max length: 50
notes

Internal notes/remarks

 string
sales_organization_id

Main organization of the user

 globally unique identifier

Optionally required : sales_organization_id, sales_organization_code or sales_organization must be provided
sales_organization

Embedded entity "sales_organization" when adding/updating user

 sales_organization

Optionally required : sales_organization_id, sales_organization_code or sales_organization must be provided
sales_organization_code

Embedded entity "sales_organization" using ERP PK when adding/updating user

 string

Optionally required : sales_organization_id, sales_organization_code or sales_organization must be provided
is_team_leader

Specify if this user can be used as a team leader

 boolean
team_leader_user_id

Specify his team leader if this user is a team member

 globally unique identifier
email

Email of the user

 string

Required

Max length: 255
phone

Phone number of the user

 string

Max length: 50
fax

Fax number of the user

 string

Max length: 50
mobile

Mobile number of the user

 string

Max length: 50
private_email

Private Email of the user

 string

Max length: 250
private_phone

Private Phone number of the user

 string

Max length: 50
private_fax

Private Fax number of the user

 string

Max length: 50
private_mobile

Private Mobile number of the user

 string

Max length: 50
private_street

Private Address:Street

 string

Max length: 50
private_street_number

Private Address:Street Number

 string

Max length: 50
private_city

Private Address:City

 string

Max length: 50
private_zip

Private Address:Zip

 string

Max length: 50
private_db_country_id

Private Address:Country

 globally unique identifier
private_db_country_code

Private Address:CountryCode entity using international code when adding/updating user

 string
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

 date
allow_hero_app

Specify if this user has priviliages to hero app

 boolean
allow_sales_app

Specify if this user has priviliages to salse app

 boolean
allow_service_app

Specify if this user has priviliages to service app

 boolean
user_group_id

Specify the user group that user belongs to

 globally unique identifier

Response Formats

application/json, text/json

Sample: 
{
  "id": "cb68cc7b-74dc-457a-9f5a-8ccb179b9b13",
  "db_language_id": "cec4017e-f58e-4cca-8f38-9aa801ab20c7",
  "username": "sample string 3",
  "firstname": "sample string 4",
  "lastname": "sample string 5",
  "code": "sample string 6",
  "archived": true,
  "disabled": true,
  "emergency_contact": "sample string 9",
  "bankaccount": "sample string 10",
  "social_security": "sample string 11",
  "place_of_birth": "sample string 12",
  "nationality": "sample string 13",
  "functions": "sample string 14",
  "birthdate": "2024-12-21T16:50:19.0285626+00:00",
  "skype": "sample string 16",
  "notes": "sample string 17",
  "sales_organization_id": "2b9d9664-f84d-4fba-9780-9d621d212264",
  "sales_organization": {
    "id": "d7e9dc3e-24b8-481c-a157-d8e6c213f0e6",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "db_country_id": "4b91c2cc-6cf1-4cb6-b3bd-aa85ad1e8faf",
    "db_currency_id": "b807c342-f554-4c61-b475-899baa3fe87d",
    "db_language_id": "d746fca0-4b43-4b42-a2e4-5ce1727f3d55",
    "accountancy_code": "sample string 8",
    "archived": true,
    "default_unit_of_measure_system_type": "sample string 10",
    "street": "sample string 11",
    "street2": "sample string 12",
    "street_number": "sample string 13",
    "zip": "sample string 14",
    "city": "sample string 15",
    "email": "sample string 16",
    "phone": "sample string 17",
    "fax": "sample string 18",
    "url": "sample string 19",
    "vat_reg_code": "sample string 20",
    "modified_dateutc": "2024-12-21T16:50:19.0285626+00:00"
  },
  "sales_organization_code": "sample string 19",
  "is_team_leader": true,
  "team_leader_user_id": "f1f8b4b3-9b5a-4a97-9c37-3b91bbc54c29",
  "email": "sample string 22",
  "phone": "sample string 23",
  "fax": "sample string 24",
  "mobile": "sample string 25",
  "private_email": "sample string 26",
  "private_phone": "sample string 27",
  "private_fax": "sample string 28",
  "private_mobile": "sample string 29",
  "private_street": "sample string 30",
  "private_street_number": "sample string 31",
  "private_city": "sample string 32",
  "private_zip": "sample string 33",
  "private_db_country_id": "4395971c-4b1b-49f2-ae96-90080dd716d3",
  "private_db_country_code": "sample string 35",
  "modified_dateutc": "2024-12-21T16:50:19.0285626+00:00",
  "allow_hero_app": true,
  "allow_sales_app": true,
  "allow_service_app": true,
  "user_group_id": "4a3e1aeb-7843-4be5-8756-da45c55783b7"
}