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": "587f4831-b304-4dc0-8ff5-0e01594b9979",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "62e09881-f1a4-4720-b2de-cad7ebc74a7b",
"company_code": "sample string 5",
"company": {
"id": "f947145a-bdf6-4251-acd8-da4ef54af238",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-11T02:49:42.3667081+00:00",
"sales_territory_id": "2ae4c28a-c800-468b-9f8b-69cd50fbc9b1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6d365040-ac4c-4086-802e-c66d647ffbae",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e78c1487-5366-428f-a9b1-2edf8e9504e2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "786f05f8-784d-49fe-a2fb-49c765eb6940",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7de6f70f-3bb9-423b-8635-181dfa05b61c",
"db_currency_id": "8d9f78d1-ec8c-4b8a-ae97-cea01d834db0",
"db_language_id": "ac09e77c-8e83-4d67-95e2-bfc4fa94a672",
"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-06-11T02:49:42.3667081+00:00"
},
"modified_dateutc": "2026-06-11T02:49:42.3823274+00:00"
},
"marketing_segment_id": "0cfb3dd8-b44c-4404-b5ce-b8c812ac6e60",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8576a540-3d4a-4b33-8c7e-07bf8bc834c3",
"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": "e0b22221-3d48-4e8e-b9ca-a0924af7db3a",
"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": "24a5d0d2-2fdd-41e0-bcea-b10e5a21c10e",
"db_country_code": "sample string 28",
"feelist_id": "800780e5-2f5a-4659-b086-4c3bfc142fa7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "74747ef6-8fd8-4332-b9b2-41b166d227d3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "82f8fe8a-a9b8-49a4-a0d8-36f42c145b49",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-11T02:49:42.3823274+00:00",
"db_currency_id": "967a1ab1-a920-4bd1-ac70-5b337c7eeabf",
"db_currency_code": "sample string 10"
},
"company_type_id": "38d83b6b-ff4c-4ec7-af46-b29a0a8a9b2c",
"company_type_name": "sample string 32",
"company_type": {
"id": "07f26023-8558-49f9-b7bc-f39b1aa4c0cd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "06db1954-df44-4b78-a214-129d96d4f033",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a2f95030-4b12-44d7-b598-86dbd7aafa42",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "861d71c2-2e70-4779-a85b-35da073b9563",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fa2ad2a6-8148-4e0d-aae2-88035186891b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3075e638-eab3-42d8-a4be-86bd03ba0769",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-11T02:49:42.3823274+00:00"
},
"company_sector_id": "e64e9c8e-b6cc-4e9f-aab9-902391a4d24a",
"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": "08f9b77b-d027-4816-af81-2dc0cac5f2e8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "29f8e29e-3742-4b2f-a294-60b7317c2270",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ca4a6240-9bb8-4cec-9c35-4a766feece2a",
"account_manager_user_code": "sample string 56",
"company_status_id": "5a0feae6-f08c-4eab-b87e-d5c2949e0934",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-11T02:49:42.3823274+00:00",
"id2": 60
},
"db_language_id": "05492d47-021a-4596-ba5a-35d1ec860cb8",
"db_language_code": "sample string 7",
"db_title_id": "beae7877-e99c-4334-be1a-340d8e29d2c4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-11T02:49:42.3823274+00:00",
"create_date": "2026-06-11T02:49:42.3823274+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-06-11T02:49:42.3823274+00:00"
}