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": "9cd2d81e-1f13-4b54-b279-f56f59a2363a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "949ee96b-4cff-4663-b8ab-1c2749bea908",
"company_code": "sample string 5",
"company": {
"id": "476d28e4-5b89-4217-8f46-261aa841f8e0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-06T04:12:16.2531433+00:00",
"sales_territory_id": "ce25d0fd-30ec-422f-a636-96fce70b9438",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cb079843-891b-4a91-9a23-8d9fe0971887",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "21fae908-a701-436c-bb99-e343a99d2bb0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "61b11d19-e3cd-46d1-84a8-4ea219f7fd36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34b725d2-916c-4d46-9fb7-e72a40441f2c",
"db_currency_id": "a4f8e2db-92cc-433b-88d5-f6fcb8cbb9e6",
"db_language_id": "106e1b4b-24e0-4f6d-ae04-2b74b617534b",
"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-03-06T04:12:16.2531433+00:00"
},
"modified_dateutc": "2026-03-06T04:12:16.2531433+00:00"
},
"marketing_segment_id": "1e3b8564-1325-4cd6-8ada-23132ae59177",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6ecbfa15-2bd2-49d2-96a2-8ec40426f34d",
"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": "005acf15-f041-4f19-b4cb-a2245b5191f4",
"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": "c0125854-23d1-443e-a357-da8ead69620f",
"db_country_code": "sample string 28",
"feelist_id": "f44eb395-9d0f-443f-a65e-9f5b7f219915",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7eb77c14-4b51-4fe0-ae14-45cfcda8fb48",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "36affc27-f493-4840-8321-f4eb197a92aa",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-06T04:12:16.2531433+00:00",
"db_currency_id": "e6dfdd34-e24e-46d0-ba36-0571ceb08eec",
"db_currency_code": "sample string 10"
},
"company_type_id": "1a28bc5e-4d0a-482c-8e94-a3b8cd1650b3",
"company_type_name": "sample string 32",
"company_type": {
"id": "301f9e07-e7bc-4d56-bd96-229027ba0cd0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8d757c69-bffb-4f4a-b597-fd4973ae01be",
"sales_organization_code": "sample string 5"
},
"db_language_id": "393d7266-f5bc-4431-9781-8dac34622b34",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c1d778f9-323e-4f90-a6fd-350e5b8f60ac",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d8292641-5420-43c2-b9ce-e227f35f1df9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e2f322c9-b688-4ac8-95d6-f7167842154a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-06T04:12:16.2531433+00:00"
},
"company_sector_id": "fd9cb142-0ec5-46ec-be7c-6683c635106c",
"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": "663e9767-4f2c-489c-9b4c-9587512ec7d6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d1a37c23-6556-4b7b-9ffc-d553040bb955",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "df176b4d-8932-45d2-9a60-ad4a9e0654ff",
"account_manager_user_code": "sample string 56",
"company_status_id": "b5e13aab-a685-4dcb-8feb-fe56dfc5e411",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-06T04:12:16.2531433+00:00",
"id2": 60
},
"db_language_id": "cfaf2381-9530-4080-862f-4aed3b3a7620",
"db_language_code": "sample string 7",
"db_title_id": "4c3f5a72-0437-4494-82d4-3da231d219b9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-06T04:12:16.2531433+00:00",
"create_date": "2026-03-06T04:12:16.2531433+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-03-06T04:12:16.2531433+00:00"
}