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": "b4c864bc-fa7a-4999-8f74-af00cca0ac8d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7a5adc52-73a5-4aff-8f63-d160ac003ab5",
"company_code": "sample string 5",
"company": {
"id": "b765f78e-a267-40d6-92f3-23930a9d6a53",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-14T15:16:27.9776352+00:00",
"sales_territory_id": "4f868a30-9214-4d24-ab1f-4c488499c23a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6cee8acd-21bf-436a-94b9-87a20e30a392",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7fc0e116-370e-400e-aa18-a6464c0fc65f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d8fc06ba-2a32-4b85-8cc9-211409e0baea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "797b5000-3343-4521-99dd-0ab09acac61a",
"db_currency_id": "39ec3445-57e2-4be4-b549-860599d470c4",
"db_language_id": "eacdfe01-cdd4-4f84-a1db-e3d6d121281b",
"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-06-14T15:16:27.9776352+00:00"
},
"modified_dateutc": "2026-06-14T15:16:27.9776352+00:00"
},
"marketing_segment_id": "64e56ccb-c756-405d-917d-3d3ee836f595",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "aae7d2fe-b729-4535-8d4b-90f198e6bc74",
"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": "727812b4-6597-40b4-8c46-61a5f3058da1",
"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": "7feae59b-c66d-4bca-8138-3f9195ad6009",
"db_country_code": "sample string 28",
"feelist_id": "217ad63d-e296-48c5-a4ea-4bda8e457d0d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2a37cdc4-6841-4955-b0de-3d8e222117be",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a7c8788b-f61f-4de4-b816-c3db456e19f3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-14T15:16:27.9776352+00:00",
"db_currency_id": "09199de5-23b5-406c-9313-57c01fcd8c3c",
"db_currency_code": "sample string 10"
},
"company_type_id": "dbe5f0dc-909e-4d71-acf9-bb8c47af037d",
"company_type_name": "sample string 32",
"company_type": {
"id": "50e0922c-34b8-481e-acfa-e7984e6f9950",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "58968da2-e970-4c65-abe0-89d6a2d51349",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a8652a18-0a12-4edc-9fd8-6a0f80279a78",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8de6b14d-4b6f-4fa0-b14c-1c44292b7357",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0b862d0e-346d-4eda-b45a-113007311aa2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d9e83a44-b7f7-4e8e-9a0d-8e00991d2183",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-14T15:16:27.9776352+00:00"
},
"company_sector_id": "f77a7662-bddb-4bad-9f13-9ad92d10343f",
"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": "334321a0-c03a-4ba1-9818-084ce07606c6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9b6d844a-f2f6-44b0-b160-cc85fcd8a132",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "30b3d955-6706-4e75-bdef-c3375fd75f0f",
"account_manager_user_code": "sample string 56",
"company_status_id": "9634560f-1756-4048-bae8-d993bdb08baa",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-14T15:16:27.9776352+00:00",
"id2": 60
},
"db_language_id": "9c4b7531-c08a-4150-aba2-77e1c67316ab",
"db_language_code": "sample string 7",
"db_title_id": "1b682eeb-1ad1-4586-a607-963adf97a876",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-14T15:16:27.9776352+00:00",
"create_date": "2026-06-14T15:16:27.9776352+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-06-14T15:16:27.9776352+00:00"
}