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
udf1

Custom field udf1

string
udf2

Custom field udf2

string
udf3

Custom field udf3

string
udf4

Custom field udf4

string
udf5

Custom field udf5

string
udf6

Custom field udf6

string
udf7

Custom field udf7

string
udf8

Custom field udf8

string
udf9

Custom field udf9

string
udf10

Custom field udf10

string
udf11

Custom field udf11

string
udf12

Custom field udf12

string
udf13

Custom field udf13

string
udf14

Custom field udf14

string
udf15

Custom field udf15

string
udf16

Custom field udf16

string
udf17

Custom field udf17

string
udf18

Custom field udf18

string
udf19

Custom field udf19

string
udf20

Custom field udf20

string
udf21

Custom field udf21

string
udf22

Custom field udf22

string
udf23

Custom field udf23

string
udf24

Custom field udf24

string
udf25

Custom field udf25

string
udf26

Custom field udf26

string
udf27

Custom field udf27

string
udf28

Custom field udf28

string
udf29

Custom field udf29

string
udf30

Custom field udf30

string
udf31

Custom field udf31

string
udf32

Custom field udf32

string
udf33

Custom field udf33

string
udf34

Custom field udf34

string
udf35

Custom field udf35

string
udf36

Custom field udf36

string
udf37

Custom field udf37

string
udf38

Custom field udf38

string
udf39

Custom field udf39

string
udf40

Custom field udf40

string
udf41

Custom field udf41

string
udf42

Custom field udf42

string
udf43

Custom field udf43

string
udf44

Custom field udf44

string
udf45

Custom field udf45

string
udf46

Custom field udf46

string
udf47

Custom field udf47

string
udf48

Custom field udf48

string
udf49

Custom field udf49

string
udf50

Custom field udf50

string
udf51

Custom field udf51

string
udf52

Custom field udf52

string
udf53

Custom field udf53

string
udf54

Custom field udf54

string
udf55

Custom field udf55

string
udf56

Custom field udf56

string
udf57

Custom field udf57

string
udf58

Custom field udf58

string
udf59

Custom field udf59

string
udf60

Custom field udf60

string
udf61

Custom field udf61

string
udf62

Custom field udf62

string
udf63

Custom field udf63

string
udf64

Custom field udf64

string
udf65

Custom field udf65

string
udf66

Custom field udf66

string
udf67

Custom field udf67

string
udf68

Custom field udf68

string
udf69

Custom field udf69

string
udf70

Custom field udf70

string
udf71

Custom field udf71

string
udf72

Custom field udf72

string
udf73

Custom field udf73

string
udf74

Custom field udf74

string
udf75

Custom field udf75

string
udf76

Custom field udf76

string
udf77

Custom field udf77

string
udf78

Custom field udf78

string
udf79

Custom field udf79

string
udf80

Custom field udf80

string
udf81

Custom field udf81

string
udf82

Custom field udf82

string
udf83

Custom field udf83

string
udf84

Custom field udf84

string
udf85

Custom field udf85

string
udf86

Custom field udf86

string
udf87

Custom field udf87

string
udf88

Custom field udf88

string
udf89

Custom field udf89

string
udf90

Custom field udf90

string
udf91

Custom field udf91

string
udf92

Custom field udf92

string
udf93

Custom field udf93

string
udf94

Custom field udf94

string
udf95

Custom field udf95

string
udf96

Custom field udf96

string
udf97

Custom field udf97

string
udf98

Custom field udf98

string
udf99

Custom field udf99

string
udf100

Custom field udf100

string

Response Formats

application/json, text/json

Sample:
{
  "id": "9e2bd36a-8d5e-4456-bb5a-4f460f9993f5",
  "db_language_id": "ace1b400-a282-445c-b40e-0186a740d9ef",
  "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-09-29T05:22:37.6134053+00:00",
  "skype": "sample string 16",
  "notes": "sample string 17",
  "sales_organization_id": "5ce337fd-5766-4102-8e89-3ef8bd2e28a5",
  "sales_organization": {
    "id": "e89ee467-9a77-442e-a796-d045e00afb1f",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "db_country_id": "5f0726d8-1371-495f-9e7b-fe891fe0fecf",
    "db_currency_id": "11dc22fa-0457-45e2-bfe5-960325fa7692",
    "db_language_id": "3c2c8729-a94e-4d95-895d-c24bd3e6610d",
    "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-09-29T05:22:37.6134053+00:00"
  },
  "sales_organization_code": "sample string 19",
  "is_team_leader": true,
  "team_leader_user_id": "99efa3ec-7447-47ba-9ba3-533198fc0132",
  "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": "e1e09ecf-43f2-4913-afb4-f49515749455",
  "private_db_country_code": "sample string 35",
  "modified_dateutc": "2024-09-29T05:22:37.6134053+00:00",
  "allow_hero_app": true,
  "allow_sales_app": true,
  "allow_service_app": true,
  "user_group_id": "ecde647d-ea02-4c29-96a3-3b1c8972fd72",
  "udf1": "sample string 41",
  "udf2": "sample string 42",
  "udf3": "sample string 43",
  "udf4": "sample string 44",
  "udf5": "sample string 45",
  "udf6": "sample string 46",
  "udf7": "sample string 47",
  "udf8": "sample string 48",
  "udf9": "sample string 49",
  "udf10": "sample string 50",
  "udf11": "sample string 51",
  "udf12": "sample string 52",
  "udf13": "sample string 53",
  "udf14": "sample string 54",
  "udf15": "sample string 55",
  "udf16": "sample string 56",
  "udf17": "sample string 57",
  "udf18": "sample string 58",
  "udf19": "sample string 59",
  "udf20": "sample string 60",
  "udf21": "sample string 61",
  "udf22": "sample string 62",
  "udf23": "sample string 63",
  "udf24": "sample string 64",
  "udf25": "sample string 65",
  "udf26": "sample string 66",
  "udf27": "sample string 67",
  "udf28": "sample string 68",
  "udf29": "sample string 69",
  "udf30": "sample string 70",
  "udf31": "sample string 71",
  "udf32": "sample string 72",
  "udf33": "sample string 73",
  "udf34": "sample string 74",
  "udf35": "sample string 75",
  "udf36": "sample string 76",
  "udf37": "sample string 77",
  "udf38": "sample string 78",
  "udf39": "sample string 79",
  "udf40": "sample string 80",
  "udf41": "sample string 81",
  "udf42": "sample string 82",
  "udf43": "sample string 83",
  "udf44": "sample string 84",
  "udf45": "sample string 85",
  "udf46": "sample string 86",
  "udf47": "sample string 87",
  "udf48": "sample string 88",
  "udf49": "sample string 89",
  "udf50": "sample string 90",
  "udf51": "sample string 91",
  "udf52": "sample string 92",
  "udf53": "sample string 93",
  "udf54": "sample string 94",
  "udf55": "sample string 95",
  "udf56": "sample string 96",
  "udf57": "sample string 97",
  "udf58": "sample string 98",
  "udf59": "sample string 99",
  "udf60": "sample string 100",
  "udf61": "sample string 101",
  "udf62": "sample string 102",
  "udf63": "sample string 103",
  "udf64": "sample string 104",
  "udf65": "sample string 105",
  "udf66": "sample string 106",
  "udf67": "sample string 107",
  "udf68": "sample string 108",
  "udf69": "sample string 109",
  "udf70": "sample string 110",
  "udf71": "sample string 111",
  "udf72": "sample string 112",
  "udf73": "sample string 113",
  "udf74": "sample string 114",
  "udf75": "sample string 115",
  "udf76": "sample string 116",
  "udf77": "sample string 117",
  "udf78": "sample string 118",
  "udf79": "sample string 119",
  "udf80": "sample string 120",
  "udf81": "sample string 121",
  "udf82": "sample string 122",
  "udf83": "sample string 123",
  "udf84": "sample string 124",
  "udf85": "sample string 125",
  "udf86": "sample string 126",
  "udf87": "sample string 127",
  "udf88": "sample string 128",
  "udf89": "sample string 129",
  "udf90": "sample string 130",
  "udf91": "sample string 131",
  "udf92": "sample string 132",
  "udf93": "sample string 133",
  "udf94": "sample string 134",
  "udf95": "sample string 135",
  "udf96": "sample string 136",
  "udf97": "sample string 137",
  "udf98": "sample string 138",
  "udf99": "sample string 139",
  "udf100": "sample string 140"
}