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": "bd29fca4-2d85-45a7-81ce-d9aecbaf6412",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f6e07cb5-d06b-43ae-9436-4fd8008d1e2c",
"company_code": "sample string 5",
"company": {
"id": "197ce168-93c9-4cff-b9c9-4036595eb264",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-09T12:17:16.2125123+00:00",
"sales_territory_id": "708dc9eb-7b6b-433b-9116-17b0fca8608e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a512b2c7-b69a-4cc5-8254-37453cdb87ce",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "961ba0ee-8db0-4b03-893e-85e7634d6444",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "682aead4-9b10-44eb-b08b-d75a528f2666",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ad482c9-5baf-4fe6-87bd-91474ec98d79",
"db_currency_id": "6f1f4b43-3168-42e2-99ef-f9e22527d5d5",
"db_language_id": "6795bd77-71f5-4b17-a883-56dd774c4cea",
"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-11-09T12:17:16.2125123+00:00"
},
"modified_dateutc": "2026-11-09T12:17:16.2125123+00:00"
},
"marketing_segment_id": "4a1c869e-9adf-4d3f-8a5a-229eecf920f3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9924447d-ecbe-4a67-af3f-a106902573f1",
"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": "5e78dc45-10c9-45ff-a9ad-d09a9e95531a",
"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": "7e1eee4d-8dca-42f0-a1dd-c099d3872fe1",
"db_country_code": "sample string 28",
"feelist_id": "7386a661-e1fc-43ca-86b6-1b7db0ab8fcc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "36066c88-42ea-47c6-9626-2457920e2e90",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "40c136cb-907f-4f9c-aeb3-19e3d7c66991",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-09T12:17:16.2125123+00:00",
"db_currency_id": "6a347397-dbde-4830-97ef-9b6bbd46d5f0",
"db_currency_code": "sample string 10"
},
"company_type_id": "5c4ee602-92b1-4624-a450-c60a9378e7ba",
"company_type_name": "sample string 32",
"company_type": {
"id": "e3df5f5e-3a7b-4876-81cb-98aa52678a19",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5530e5cb-b0f7-4aae-acbf-3532d3767ce8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "236b2dc7-0c1a-40d7-85db-1f7bd86cb4c9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "aec350d6-52eb-4352-9290-2867010320e9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2ffc3a31-e383-4951-9ab1-621b90db0736",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "66963b4e-84e9-402c-9f78-c207988bc9c1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-09T12:17:16.2125123+00:00"
},
"company_sector_id": "246ba6c2-bd4a-45a7-8c5f-d94e56c7015c",
"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": "a10321fa-a9d9-45ac-8373-652509dd7452",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "054c5e6b-ea5d-4c6f-87bb-b56a3f58d3b1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "69789fa3-da24-40f2-9a11-e0aed92bde3a",
"account_manager_user_code": "sample string 56",
"company_status_id": "c8a8a565-9576-4386-a363-7bf5f096c137",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-09T12:17:16.2125123+00:00",
"id2": 60
},
"db_language_id": "413f21dc-f2a8-478a-8123-32d20d839553",
"db_language_code": "sample string 7",
"db_title_id": "16cbad97-2078-4213-a2e3-fd28a3dadfe9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-09T12:17:16.2125123+00:00",
"create_date": "2026-11-09T12:17:16.2125123+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-11-09T12:17:16.2125123+00:00"
}