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": "818f9285-41c3-4971-9b3c-6d19eb96311b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bb4bc3ff-e107-449e-9777-08d40dcf5c42",
"company_code": "sample string 5",
"company": {
"id": "5833291c-e9cb-4cd4-ab37-16f38e4f53c3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-15T04:58:34.7960972+00:00",
"sales_territory_id": "d5414a98-daa4-4fad-99e9-60d66ae75f40",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "78ca9c85-7691-4544-ad3c-e548a19a13c9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b5c762f6-f343-4f3c-bc50-aff62d14ac7f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6b184cd4-4ecf-4266-a778-8c8f0713cc52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7efbb9ed-e75a-47ed-8be5-672516915821",
"db_currency_id": "4a9a35d5-6203-4c28-a212-6760945aa906",
"db_language_id": "3cedca3a-89a3-455e-b7ba-69703237a762",
"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-08-15T04:58:34.7960972+00:00"
},
"modified_dateutc": "2025-08-15T04:58:34.7960972+00:00"
},
"marketing_segment_id": "cd609e06-0d28-4d53-bd7a-698ffe0b95fc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "58d29e4f-edf7-4240-93cd-d13af3ad6e65",
"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": "5230ca73-44a9-4dd1-9303-8dce43f83507",
"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": "172bc245-cd0d-4389-9c24-90008b80a20b",
"db_country_code": "sample string 28",
"feelist_id": "7b801b70-ec3c-4935-bf4c-b7f1ca515720",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6712626e-d4bf-4277-9d59-3d5e60933c7d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5217a8fb-052c-4e87-bb22-4104692ef318",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-15T04:58:34.7960972+00:00",
"db_currency_id": "0c4c9c25-1896-4c44-809a-64438f4b2201",
"db_currency_code": "sample string 10"
},
"company_type_id": "e542328f-739b-47dd-871c-1d110d332027",
"company_type_name": "sample string 32",
"company_type": {
"id": "73fb03cf-d79c-4652-afc1-e2cb800ed079",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "023a851c-4563-4b7c-bdf7-cc3dfdff6f70",
"sales_organization_code": "sample string 5"
},
"db_language_id": "66e25fe6-92dc-4ff0-8e2a-d500e1ec97fe",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "32d60045-be02-439c-886e-11e165cca98b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "eadf1614-295e-484f-a313-48c80d9feaf9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ddd82ce7-4bab-4def-8ba7-52e6d84a8625",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-15T04:58:34.7960972+00:00"
},
"company_sector_id": "8456062d-d97f-4b4f-bc3a-d11aa062f1ad",
"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": "ddae6826-150d-454e-8b04-032c9b600615",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e30c509b-7485-45c6-bec8-97e9cad71ca5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f0ca948b-08ff-4677-a1f1-ca0ffcd180e3",
"account_manager_user_code": "sample string 56",
"company_status_id": "5cabf518-88b8-459e-9ebd-fa34ab78d032",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-15T04:58:34.7960972+00:00",
"id2": 60,
"udf1": "sample string 61",
"udf2": "sample string 62",
"udf3": "sample string 63",
"udf4": "sample string 64",
"udf5": "sample string 65",
"udf6": "sample string 66",
"udf7": "sample string 67",
"udf8": "sample string 68",
"udf9": "sample string 69",
"udf10": "sample string 70",
"udf11": "sample string 71",
"udf12": "sample string 72",
"udf13": "sample string 73",
"udf14": "sample string 74",
"udf15": "sample string 75",
"udf16": "sample string 76",
"udf17": "sample string 77",
"udf18": "sample string 78",
"udf19": "sample string 79",
"udf20": "sample string 80",
"udf21": "sample string 81",
"udf22": "sample string 82",
"udf23": "sample string 83",
"udf24": "sample string 84",
"udf25": "sample string 85",
"udf26": "sample string 86",
"udf27": "sample string 87",
"udf28": "sample string 88",
"udf29": "sample string 89",
"udf30": "sample string 90",
"udf31": "sample string 91",
"udf32": "sample string 92",
"udf33": "sample string 93",
"udf34": "sample string 94",
"udf35": "sample string 95",
"udf36": "sample string 96",
"udf37": "sample string 97",
"udf38": "sample string 98",
"udf39": "sample string 99",
"udf40": "sample string 100",
"udf41": "sample string 101",
"udf42": "sample string 102",
"udf43": "sample string 103",
"udf44": "sample string 104",
"udf45": "sample string 105",
"udf46": "sample string 106",
"udf47": "sample string 107",
"udf48": "sample string 108",
"udf49": "sample string 109",
"udf50": "sample string 110",
"udf51": "sample string 111",
"udf52": "sample string 112",
"udf53": "sample string 113",
"udf54": "sample string 114",
"udf55": "sample string 115",
"udf56": "sample string 116",
"udf57": "sample string 117",
"udf58": "sample string 118",
"udf59": "sample string 119",
"udf60": "sample string 120",
"udf61": "sample string 121",
"udf62": "sample string 122",
"udf63": "sample string 123",
"udf64": "sample string 124",
"udf65": "sample string 125",
"udf66": "sample string 126",
"udf67": "sample string 127",
"udf68": "sample string 128",
"udf69": "sample string 129",
"udf70": "sample string 130",
"udf71": "sample string 131",
"udf72": "sample string 132",
"udf73": "sample string 133",
"udf74": "sample string 134",
"udf75": "sample string 135",
"udf76": "sample string 136",
"udf77": "sample string 137",
"udf78": "sample string 138",
"udf79": "sample string 139",
"udf80": "sample string 140",
"udf81": "sample string 141",
"udf82": "sample string 142",
"udf83": "sample string 143",
"udf84": "sample string 144",
"udf85": "sample string 145",
"udf86": "sample string 146",
"udf87": "sample string 147",
"udf88": "sample string 148",
"udf89": "sample string 149",
"udf90": "sample string 150",
"udf91": "sample string 151",
"udf92": "sample string 152",
"udf93": "sample string 153",
"udf94": "sample string 154",
"udf95": "sample string 155",
"udf96": "sample string 156",
"udf97": "sample string 157",
"udf98": "sample string 158",
"udf99": "sample string 159",
"udf100": "sample string 160"
},
"db_language_id": "9ff6e1b4-14c5-4fa0-9c76-fb22dd109bad",
"db_language_code": "sample string 7",
"db_title_id": "003bd0b4-1bcd-432d-9c21-5c171d268d91",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-15T04:58:34.7960972+00:00",
"create_date": "2025-08-15T04:58:34.7960972+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-08-15T04:58:34.7960972+00:00"
}