Retrieves all the contacts
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
Company of the contact |
globally unique identifier |
Optionally required : company_id,company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating contact |
string |
Optionally required : company_id,company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating contact |
company |
Optionally required : company_id,company_code or company must be provided |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating contact |
string | |
| db_title_id |
The title of the contact |
globally unique identifier | |
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| e_login |
Login of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| e_password |
Password in clear text of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| notes |
Notes/Remark field |
string | |
| birthdate |
Birthday date |
date | |
| create_date |
Creation date+time |
date | |
| phone |
Phone number of the contact |
string |
Max length: 50 |
| mobile |
a number of the contact |
string |
Max length: 50 |
|
|
string |
Max length: 250 |
|
| skype |
skype |
string |
Max length: 250 |
| private_phone |
Private phone number of the contact |
string |
Max length: 50 |
| private_mobile |
Private mobile number of the contact |
string |
Max length: 50 |
| private_email |
Private email |
string |
Max length: 250 |
| reference_back_office |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "00bbf6be-3b82-47c7-a968-53e2577e6ebb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6f2bcb51-f2da-4087-9730-77dd70775e7b",
"company_code": "sample string 5",
"company": {
"id": "0bb99a67-d4ee-4647-9d5b-a123ba93c786",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-12T16:12:01.1104655+00:00",
"sales_territory_id": "9b27a26b-f542-4f09-88a3-8dfd298a2dad",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "33850fa6-bb65-4304-b82e-5050c1f30aed",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c1f3d8f1-6e2d-4870-9a48-a6fa998d978d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "18f4d692-681d-4d89-9b76-0fb0816089b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d31f3d5e-f559-450c-9f1f-83b3f498856f",
"db_currency_id": "029c8bd9-00d7-4012-a0b4-9a41d476c145",
"db_language_id": "1e11f037-8f37-4d56-a45b-ab4469eff403",
"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-12-12T16:12:01.1283121+00:00"
},
"modified_dateutc": "2025-12-12T16:12:01.1283121+00:00"
},
"marketing_segment_id": "543f4091-ae8b-4e35-a01e-4dd35bbb7dd7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8fb176b5-2210-4ef6-8e82-76d00d1c47e3",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "40b8e3f0-41df-4869-bd7e-0b543c7dd091",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "309b1c3d-9697-4016-872a-b5cfa1901a67",
"db_country_code": "sample string 28",
"feelist_id": "ca878626-0735-49d2-b311-94ccf0804e6f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a035cd1f-b7ed-4a56-92a1-afb56fd6f517",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4bfb2fc5-cb81-47d8-bd4e-3182604f720e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-12T16:12:01.1283121+00:00",
"db_currency_id": "658a4da4-0bc1-4af4-9fa6-dba6cf192ae4",
"db_currency_code": "sample string 10"
},
"company_type_id": "83b5c06e-b549-4f76-8af4-d01e539f9cda",
"company_type_name": "sample string 32",
"company_type": {
"id": "8be85320-b96b-4303-bf90-77a0035b7d07",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d1017de7-c595-498d-8189-c6c1962fdf97",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7d0b07ac-421b-4707-aab1-92d95fd9f335",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6758abb9-3f95-4d33-89e1-0538e02297ce",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3aee4c54-f4fa-4f93-88d2-affe1ce05611",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "255e1534-4c60-4298-a367-c507c3a92c1a",
"name": "sample string 2",
"pm": "sample string 3",
"description": "sample string 4",
"reference_back_office": "sample string 5",
"activated": true,
"modified_dateutc": "2025-12-12T16:12:01.1283121+00:00"
},
"company_sector_id": "3cfbcffa-294d-4404-9983-dde787b95a80",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "38706488-4299-4df2-ab82-a7849ddf6fce",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d0727b34-b004-4443-ba00-eefcfe4c0b5b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "58f24f12-2b4b-46f0-86d9-9d4cc0a2859d",
"account_manager_user_code": "sample string 56",
"company_status_id": "127eb8b1-bec5-4f14-b186-0857b755a417",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-12T16:12:01.1283121+00:00",
"id2": 60,
"po_number_required": true,
"invoice_contact_id": "8bcd2669-726b-4ee7-992f-3abf4f0e2c7c",
"due_monthend": true,
"payement_conditions": "sample string 64",
"udf1": "sample string 65",
"udf2": "sample string 66",
"udf3": "sample string 67",
"udf4": "sample string 68",
"udf5": "sample string 69",
"udf6": "sample string 70",
"udf7": "sample string 71",
"udf8": "sample string 72",
"udf9": "sample string 73",
"udf10": "sample string 74",
"udf11": "sample string 75",
"udf12": "sample string 76",
"udf13": "sample string 77",
"udf14": "sample string 78",
"udf15": "sample string 79",
"udf16": "sample string 80",
"udf17": "sample string 81",
"udf18": "sample string 82",
"udf19": "sample string 83",
"udf20": "sample string 84",
"udf21": "sample string 85",
"udf22": "sample string 86",
"udf23": "sample string 87",
"udf24": "sample string 88",
"udf25": "sample string 89",
"udf26": "sample string 90",
"udf27": "sample string 91",
"udf28": "sample string 92",
"udf29": "sample string 93",
"udf30": "sample string 94",
"udf31": "sample string 95",
"udf32": "sample string 96",
"udf33": "sample string 97",
"udf34": "sample string 98",
"udf35": "sample string 99",
"udf36": "sample string 100",
"udf37": "sample string 101",
"udf38": "sample string 102",
"udf39": "sample string 103",
"udf40": "sample string 104",
"udf41": "sample string 105",
"udf42": "sample string 106",
"udf43": "sample string 107",
"udf44": "sample string 108",
"udf45": "sample string 109",
"udf46": "sample string 110",
"udf47": "sample string 111",
"udf48": "sample string 112",
"udf49": "sample string 113",
"udf50": "sample string 114",
"udf51": "sample string 115",
"udf52": "sample string 116",
"udf53": "sample string 117",
"udf54": "sample string 118",
"udf55": "sample string 119",
"udf56": "sample string 120",
"udf57": "sample string 121",
"udf58": "sample string 122",
"udf59": "sample string 123",
"udf60": "sample string 124",
"udf61": "sample string 125",
"udf62": "sample string 126",
"udf63": "sample string 127",
"udf64": "sample string 128",
"udf65": "sample string 129",
"udf66": "sample string 130",
"udf67": "sample string 131",
"udf68": "sample string 132",
"udf69": "sample string 133",
"udf70": "sample string 134",
"udf71": "sample string 135",
"udf72": "sample string 136",
"udf73": "sample string 137",
"udf74": "sample string 138",
"udf75": "sample string 139",
"udf76": "sample string 140",
"udf77": "sample string 141",
"udf78": "sample string 142",
"udf79": "sample string 143",
"udf80": "sample string 144",
"udf81": "sample string 145",
"udf82": "sample string 146",
"udf83": "sample string 147",
"udf84": "sample string 148",
"udf85": "sample string 149",
"udf86": "sample string 150",
"udf87": "sample string 151",
"udf88": "sample string 152",
"udf89": "sample string 153",
"udf90": "sample string 154",
"udf91": "sample string 155",
"udf92": "sample string 156",
"udf93": "sample string 157",
"udf94": "sample string 158",
"udf95": "sample string 159",
"udf96": "sample string 160",
"udf97": "sample string 161",
"udf98": "sample string 162",
"udf99": "sample string 163",
"udf100": "sample string 164"
},
"db_language_id": "99237dbd-9df8-4f11-a2a0-1565493fa93e",
"db_language_code": "sample string 7",
"db_title_id": "308b9f30-2c2b-4461-ad7f-9bae7682b740",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-12T16:12:01.1283121+00:00",
"create_date": "2025-12-12T16:12:01.1283121+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2025-12-12T16:12:01.1283121+00:00"
}