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": "eb28ab35-5659-4df1-b37a-9f7fea14d0c9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "74a66b4d-3502-4d97-8557-25e564bb707b",
"company_code": "sample string 5",
"company": {
"id": "c16ec110-8c0b-4ae3-a5aa-fbbeacd789a6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-09T14:48:14.7232834+00:00",
"sales_territory_id": "1350c46b-039a-4846-bc40-bf262a71e59a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c7e2952b-739a-42e4-add0-e7a3ceb7de49",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9e54d22b-36bf-44c3-86d2-70259df1be87",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f4157478-c5da-4703-9275-30a277b3ee3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7f855da-6285-42c3-ab4d-807753d9427a",
"db_currency_id": "cf9c6957-3678-4cb7-9a80-63cb3e2cad88",
"db_language_id": "eae9b55d-53a9-4dbd-aebb-236faf760f29",
"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-07-09T14:48:14.7232834+00:00"
},
"modified_dateutc": "2026-07-09T14:48:14.7232834+00:00"
},
"marketing_segment_id": "da781323-3d26-4377-975f-87b5f90bfb39",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a9bed0d2-db71-4733-9cf3-4e95482d7927",
"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": "3efea4af-9f66-40f6-8392-36a8161d9da2",
"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": "08ed1fa9-88b5-4662-adc3-65f1026c18da",
"db_country_code": "sample string 28",
"feelist_id": "ad64709b-8403-4db3-a826-f78e98f7be84",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "237d9100-983a-472f-bd24-1a507353070f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "df18bbb3-7eff-49c1-8a21-6945e2b52531",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-09T14:48:14.7232834+00:00",
"db_currency_id": "540ca40e-789f-4f94-bcee-53e9c4009727",
"db_currency_code": "sample string 10"
},
"company_type_id": "8b4b624c-5d4a-473f-8fc5-bf3a97f0db57",
"company_type_name": "sample string 32",
"company_type": {
"id": "9bf7d387-e568-40dd-870a-5f1b72ca3e81",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "db649467-8bda-444c-93df-ef6a8ca31dbb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7ea687ed-3018-4654-b70f-4b9ce535cb51",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9cabf443-70b4-4fdd-92e9-b20abe7f70fb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "eb140cb4-352d-4bfc-9709-a8db6a8c9210",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "281db204-60a8-4d3c-b3d2-0d9e9e39dc96",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-09T14:48:14.7232834+00:00"
},
"company_sector_id": "462ecbbe-44b7-4972-b804-bc650866df12",
"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": "1c40dca7-4b9b-46d7-bc42-f77eb99ea87e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4db78058-0cd4-4edf-9b54-e6b02444cb22",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a75968ee-9dab-4787-a483-cf01ec8f4fd7",
"account_manager_user_code": "sample string 56",
"company_status_id": "b91d28ee-90e5-491d-94c1-2c849cfc7511",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-09T14:48:14.7232834+00:00",
"id2": 60
},
"db_language_id": "8b45a236-df8a-44a8-87a6-fc8d1ff51220",
"db_language_code": "sample string 7",
"db_title_id": "6e5d2b1a-ce2d-47c3-bdf6-fe0f742929ba",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-09T14:48:14.7232834+00:00",
"create_date": "2026-07-09T14:48:14.7232834+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-07-09T14:48:14.7232834+00:00"
}