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": "afa3190e-f64c-4099-ac3f-e9f9bb0d9a6b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2c6d454c-dbcb-4a14-b79c-5d367cf0bc44",
"company_code": "sample string 5",
"company": {
"id": "aff7aa69-4e26-45c1-89d0-5129b7797998",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-28T18:16:18.4055905+00:00",
"sales_territory_id": "70a31f10-d675-4269-b18e-9584d4d40a81",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "966b56f9-bf44-4026-aa6b-532b920aed4d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a0efdd6f-68dd-4802-8e1e-5b1a7fae5c22",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8406145f-bf89-43ab-bf3e-dd028e1648bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73bc2487-6cfc-4860-91bf-c7783fc3ce4c",
"db_currency_id": "0296aa79-8c60-444a-ba1a-d2e6dd86ac70",
"db_language_id": "9eb1bf25-6564-4f7c-9cac-a5ccdcda5169",
"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": "2026-04-28T18:16:18.4055905+00:00"
},
"modified_dateutc": "2026-04-28T18:16:18.4055905+00:00"
},
"marketing_segment_id": "aa4b76d4-7f9e-4cbf-8c37-9ee29bc864a5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d004f83f-dfce-43a5-a6b5-50a768c3e0a4",
"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": "f8a826d3-ae66-44e3-a1ce-ca8f1eca3a5e",
"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": "3870940d-04f3-4e3e-9c12-8d6874985876",
"db_country_code": "sample string 28",
"feelist_id": "9003c0a8-698c-4bea-8449-be6f0b9eb2ca",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "213c6a21-0e35-44bb-ab09-783002d62cb4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1f599180-465d-4ff5-9041-d07397bff89b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-28T18:16:18.4055905+00:00",
"db_currency_id": "e9096962-983f-45e4-8df7-943d9ca49db3",
"db_currency_code": "sample string 10"
},
"company_type_id": "adbb7d81-a164-417d-8dcb-3e622d3e38a0",
"company_type_name": "sample string 32",
"company_type": {
"id": "935d0ea2-864b-4e1c-9bb5-102a95772b4c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a126b042-a2ff-4414-b156-941868c865a3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "af562d46-cf2e-463d-8882-c39c7adbccfb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ab056032-e728-4545-8c12-98766ef63f1f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "789625e0-4121-4678-8392-111de24e430a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "51f20578-d82c-4e8c-af34-979a08c6c189",
"name": "sample string 2",
"pm": "sample string 3",
"description": "sample string 4",
"reference_back_office": "sample string 5",
"activated": true,
"modified_dateutc": "2026-04-28T18:16:18.4055905+00:00"
},
"company_sector_id": "7bc69de1-4a2d-4c64-8396-262226285cac",
"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": "f98bc346-f2a9-429b-9720-2c0a12ae8ced",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2af41b30-abeb-4519-ae41-3dab39c95426",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "538d178d-c46e-4fb5-aaa2-c0d033fc7daf",
"account_manager_user_code": "sample string 56",
"company_status_id": "8a9a9ccc-b9e4-45fb-9e7e-44644f41fea9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-28T18:16:18.421773+00:00",
"id2": 60,
"po_number_required": true,
"invoice_contact_id": "1c07f52a-373b-43fe-a13a-27e67eb7073e",
"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": "771209b6-d162-4be6-87ee-dbfee498434d",
"db_language_code": "sample string 7",
"db_title_id": "d78e2e86-bf7b-4f30-ad76-2b8aa70676ae",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-28T18:16:18.421773+00:00",
"create_date": "2026-04-28T18:16:18.421773+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": "2026-04-28T18:16:18.421773+00:00"
}