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": "26e93e88-d061-46a4-af39-05d7953b6974",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8039ee20-99ae-4359-800b-839a362078de",
"company_code": "sample string 5",
"company": {
"id": "7993fc91-110b-417c-b9ee-e48e6b25dc8b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-06T09:53:18.906512+00:00",
"sales_territory_id": "fa83e65a-6fe4-4dce-8dc9-8ee121ddd05e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5b83768c-41b5-403c-a3e9-d5d80b07d3ec",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ea411b3e-d250-4d1b-8706-ff14a716e0db",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8af2298a-f9c7-49a1-a666-0d3fe552312d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "349446ae-0615-457f-ba43-1f14be5ec0db",
"db_currency_id": "88eae020-31b0-4f69-baea-a31abdf56d78",
"db_language_id": "caf26b6c-4498-45ba-a334-92c9b4899b22",
"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-01-06T09:53:18.906512+00:00"
},
"modified_dateutc": "2026-01-06T09:53:18.906512+00:00"
},
"marketing_segment_id": "6f4c32f3-dc75-4067-b66c-09252dd7fc9b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "96b9b5c3-b32f-453b-bde4-6a717aa2256e",
"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": "6f5088b7-e083-421f-a700-efae9f2a4330",
"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": "1bb1c197-40a0-47e7-8118-e08eb67cd250",
"db_country_code": "sample string 28",
"feelist_id": "85c73681-6a9e-481e-b522-22a651e57e19",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "de38ecac-1513-4bd9-a1c7-2661ca5e12d2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "341fe536-fc38-4176-942a-ef6fabf38bad",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-06T09:53:18.906512+00:00",
"db_currency_id": "e94ed385-5946-427a-b581-babc27ef232f",
"db_currency_code": "sample string 10"
},
"company_type_id": "5fad2f48-f15b-4ac7-85a8-2d0aa217013a",
"company_type_name": "sample string 32",
"company_type": {
"id": "65a2ef8d-4264-4cf4-9e67-d9dfd9859531",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d901f73b-054e-4792-bbad-4940a0d9a027",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5286dab3-a373-4e54-88d7-76402816cb1a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c47a9dfa-fd72-4c73-aef0-42916a7dc485",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2bf702b3-074f-4773-bbf5-6f28bd00a540",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "877a3d47-ff21-4d8e-b257-35fedcf3b14a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-06T09:53:18.9221361+00:00"
},
"company_sector_id": "510d1aba-233f-43c4-8b4c-4a488715c698",
"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": "5fe8f88a-96af-43a4-9070-f7fb123a00b5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "860154a8-87e9-481b-9563-e7e747489894",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b3f16702-2ead-434b-89aa-e6474e3b60ed",
"account_manager_user_code": "sample string 56",
"company_status_id": "800c3f35-1240-47a7-9a92-c8d7347d6b7a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-06T09:53:18.9221361+00:00",
"id2": 60
},
"db_language_id": "3820d30f-04aa-42ea-9769-3167460ecbfc",
"db_language_code": "sample string 7",
"db_title_id": "e279db9e-a134-45ac-9efe-0dd243056cfd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-06T09:53:18.9221361+00:00",
"create_date": "2026-01-06T09:53:18.9221361+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-01-06T09:53:18.9221361+00:00"
}