Retrieves the user with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
user| Name | Description | Type | Additional 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 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
{
"id": "f01c179a-4a43-49e6-8066-9ea2fdc287b5",
"db_language_id": "2db93e6d-4167-4638-80a1-9145a6809fc6",
"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": "2025-10-31T11:12:05.0940763+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "41e2c6b5-42ad-45ef-b03b-4740c7812fb2",
"sales_organization": {
"id": "8f33a95b-26f3-4c57-ae1e-b95a21764214",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a058ae26-53cf-4a91-91c5-d5bae90a0df0",
"db_currency_id": "80b1fb59-dd5d-4514-929f-0722ea1cb7f5",
"db_language_id": "4ba4c480-bf1b-4b10-a4d0-4f4f0cd0ade8",
"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": "2025-10-31T11:12:05.0940763+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "313eaa22-d2d2-4b35-8a81-0d0116061940",
"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": "3c911ea7-e008-45de-aa4b-de4fe40eee3d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-31T11:12:05.0940763+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d6d1d356-4a49-477e-9a83-90ce3eded418"
}