Retrieves all the company contact
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": "40226cfd-64d3-460b-b21f-f09d85afbd7c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bcfc8c7b-d4db-4f7d-a12c-5b9c3534565b",
"company_code": "sample string 5",
"company": {
"id": "352c9d5c-e4f6-453a-af49-a0cf3b6be129",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-17T02:01:51.8716222+00:00",
"sales_territory_id": "12d658f6-fbf5-4326-a048-aa17b000d74e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2ad6aa8c-bae7-420a-96f1-5337323f6482",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "41d3ac5e-24de-4b99-9390-4751b9547fab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "87659456-a318-492a-a397-fded6bcbfaac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d1ff085-8e58-4521-9fbc-8f65a943a8b1",
"db_currency_id": "16137f90-3cf9-4212-854b-aaec6cee1714",
"db_language_id": "491309a7-611a-4080-8425-1abeec4f3ac2",
"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-05-17T02:01:51.8716222+00:00"
},
"modified_dateutc": "2026-05-17T02:01:51.8716222+00:00"
},
"marketing_segment_id": "478344da-8600-40a5-a2cc-2c71fd45759a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3ec6891a-aa15-498c-a6f3-3aeae5626a40",
"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": "e781e0f9-c930-4030-9d4f-57a083c01f6d",
"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": "3ccbfe0e-5325-4629-9770-64ffe2747283",
"db_country_code": "sample string 28",
"feelist_id": "2d6af475-700e-41ae-a1a8-d084261370d6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "caa6846e-0502-4d47-b0fb-d57ee0d8be48",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ac865fcb-ac1a-4386-a7ea-6ea882f042f3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-17T02:01:51.8716222+00:00",
"db_currency_id": "ec6d410d-ec24-4884-94fb-29bfa927efe9",
"db_currency_code": "sample string 10"
},
"company_type_id": "2cb9c5f7-95ac-4559-bba2-9adb5d03c953",
"company_type_name": "sample string 32",
"company_type": {
"id": "7a51e9af-9c40-4da3-ba6a-579b299bcefb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d22cb71f-7b2b-494d-86e8-18de422d964c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "253196ff-f1bd-4fdd-ab35-70de64c69a36",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "056d5bc4-a1ae-432d-acd4-207377299742",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4f2066eb-a9c7-4a98-869c-0aaa40222f25",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8c888a47-8b48-43b6-b418-99e5fe192072",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-17T02:01:51.8716222+00:00"
},
"company_sector_id": "d7d964fc-8d0c-43d3-9376-ce927260c1f6",
"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": "49856b1a-d684-4054-a24c-df7857ccd911",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "764aa4bd-f525-4875-85df-3602e1cdcb16",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "51338594-a5ac-451c-a00f-d8a7cc192d4a",
"account_manager_user_code": "sample string 56",
"company_status_id": "7c492806-a416-47e7-ba69-276a68c29555",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-17T02:01:51.8716222+00:00",
"id2": 60
},
"db_language_id": "e989b60e-514e-423d-a999-16ebd4ddda29",
"db_language_code": "sample string 7",
"db_title_id": "0de9cd1f-99ab-4947-a086-af8d09e8b477",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-17T02:01:51.8716222+00:00",
"create_date": "2026-05-17T02:01:51.8716222+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-05-17T02:01:51.8716222+00:00"
}