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": "f96c5494-fd4c-4e89-9065-4dd5cae37726",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b37feb24-eabe-4a96-a476-cf16131eb4c2",
"company_code": "sample string 5",
"company": {
"id": "7e8d9744-e2f6-4810-931a-5642e12efb50",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-17T13:20:17.2411393+00:00",
"sales_territory_id": "09d7762c-7848-4116-b09c-efb5bff92f8b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6d392940-8518-4401-8563-475210be406a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7b15a1a7-8aa3-498b-9315-2697db630993",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2524dc25-70d6-4fc0-ae52-02764c55b096",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6950155-10e0-48e2-979a-d9ef8b8827ec",
"db_currency_id": "c1faf755-8235-4dc8-a549-b4993949dc48",
"db_language_id": "10e36994-4c3d-49f4-8d43-5853dbf56b3e",
"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-02-17T13:20:17.2411393+00:00"
},
"modified_dateutc": "2026-02-17T13:20:17.2411393+00:00"
},
"marketing_segment_id": "9ba8b727-9c44-446f-a161-5c71d54e353c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "523abf19-8c01-4729-b7e1-7c1ddc86fc46",
"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": "75b8df5d-7066-459d-9a49-3a59518b43a1",
"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": "1eaced7a-b153-4e64-84b9-85ffa579a674",
"db_country_code": "sample string 28",
"feelist_id": "33fc0f12-ad1c-4598-ab68-78430ed6cb99",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8194f1f6-cfb6-46b0-8cdc-0fa23e1cea0b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "48e8d242-ddd6-4908-b6d9-5e9b0bca3cb1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-17T13:20:17.2411393+00:00",
"db_currency_id": "42556597-fa5d-47ad-8eac-438f73003692",
"db_currency_code": "sample string 10"
},
"company_type_id": "5c2ac05d-af4a-4b5d-bf5a-4c2130857e19",
"company_type_name": "sample string 32",
"company_type": {
"id": "1f0bf659-caf6-4164-8f5c-3578a09061d4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e1ca0cf6-0d5b-44f3-827f-c800d4682cf5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b5c05deb-896a-4ad5-9087-b4ff9b3c6dd0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4194d1da-6d06-4f0f-8349-d591a9b38e71",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bb398f67-e961-4c34-b086-47434c5e2153",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "53c0db26-4f6a-4acb-9ec2-4e572c948b95",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-17T13:20:17.2411393+00:00"
},
"company_sector_id": "ca4c4785-ddea-4903-928b-4b2b7e9fb688",
"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": "b6add740-4f64-403b-b5d4-fdb285254374",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9a52c1f9-b5dc-4203-8644-9dc8f7473105",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2cd18d3e-c27c-4ec9-beda-c99886a53030",
"account_manager_user_code": "sample string 56",
"company_status_id": "8acd0936-4353-46e6-8850-f7f2a380def3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-17T13:20:17.2411393+00:00",
"id2": 60
},
"db_language_id": "e7571dbf-7211-4140-aac2-7dccb58db861",
"db_language_code": "sample string 7",
"db_title_id": "d91cea86-fc0f-463c-ba68-49d5b5454171",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-17T13:20:17.2411393+00:00",
"create_date": "2026-02-17T13:20:17.2411393+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-02-17T13:20:17.2411393+00:00"
}