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": "1d45d069-4a00-425c-aad0-0550f509499b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3e98fb39-3b61-4c39-bba6-ae0a8b857405",
"company_code": "sample string 5",
"company": {
"id": "26c9fada-8a5f-4ee4-a033-e83deb8a5771",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-20T03:40:47.3641708+00:00",
"sales_territory_id": "df9cb3cc-716a-4663-840d-f3c36ca35ef7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0f703aff-9f2a-45bc-b08b-5729cf65f123",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3392700b-8fe2-4443-9341-b6258f905e8a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f0f44ead-fac4-4318-b609-d44109d2855e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0e697d8-28a2-4480-a6aa-927593efbe66",
"db_currency_id": "b09fc54a-317f-4dd0-bc52-5ec5e7f153c7",
"db_language_id": "48f7540d-e914-4d07-a229-3988676d4c84",
"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-20T03:40:47.3798327+00:00"
},
"modified_dateutc": "2026-04-20T03:40:47.3798327+00:00"
},
"marketing_segment_id": "50f1aa98-09b3-4636-bc10-678ebc235c5f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3335da54-8218-4cff-9942-70671e10716b",
"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": "642cc918-dcf4-431a-88cb-cee2260ac2ee",
"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": "3b7ed37c-83e3-4b8e-9afe-a03a169254df",
"db_country_code": "sample string 28",
"feelist_id": "1d040835-8af9-4974-9b5a-b7f9188632be",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "491e994a-83bb-45ee-bf25-4a543b7a8d7a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0ca84b18-b7d1-4089-8023-f18b84109353",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-20T03:40:47.3798327+00:00",
"db_currency_id": "4d3c738a-4999-4787-b02b-f09a5de7116b",
"db_currency_code": "sample string 10"
},
"company_type_id": "cd88c482-07d3-4263-83f2-c73597fc8030",
"company_type_name": "sample string 32",
"company_type": {
"id": "dcb1a827-da29-4705-aaf4-b61b9828ab2e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "217fdcbe-6391-4b2f-b228-c5736b0c2f11",
"sales_organization_code": "sample string 5"
},
"db_language_id": "aeebb74e-a058-4baa-b710-bea15f3d4dcf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cce758cf-3bcb-4588-8ccc-d055121d53db",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1a5de4df-f53a-4c32-93ef-fdd6753e0ec5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1d035214-f7bd-4026-bb83-12457b2feb5a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-20T03:40:47.3798327+00:00"
},
"company_sector_id": "95718c68-5768-443f-acb0-87b0f8eed1d3",
"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": "2af487ce-4fbd-4df2-9a18-2001951e58f6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "198de744-2493-4640-91e3-11f8cc070d57",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6a42ea69-2a98-4f9f-93b9-3cfa8c37d4c5",
"account_manager_user_code": "sample string 56",
"company_status_id": "c5e732eb-e8c1-40be-9b2a-68ba8827c749",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-20T03:40:47.3798327+00:00",
"id2": 60
},
"db_language_id": "5e0da8f1-08e9-44da-ba6d-65b08d0a877c",
"db_language_code": "sample string 7",
"db_title_id": "0fb5970b-a066-4e41-a025-6c2135a5d49a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-20T03:40:47.3798327+00:00",
"create_date": "2026-04-20T03:40:47.3798327+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-20T03:40:47.3798327+00:00"
}