Retrieves all the contacts
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": "578493ec-60aa-4f59-b033-ceecc9fa0be2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d86320ae-59ee-456c-8a33-f768e39674c8",
"company_code": "sample string 5",
"company": {
"id": "711fc576-6102-42bb-a329-a5a07941b81f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-13T15:29:08.688854+00:00",
"sales_territory_id": "77390558-5d7a-4bfc-9ae6-fa45348b3ddb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a0c4d284-84a6-4878-9345-020b2ab8466d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d0c67a88-4937-4699-a7fd-1fc3530c1e81",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9fdd543e-fdec-4a77-9e72-cd5b5c97e28a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "644ea1a8-dabe-4c69-a721-28adb8ebabe9",
"db_currency_id": "f13688f0-081b-42b0-a742-2c5fd6115600",
"db_language_id": "069cccbb-988e-4607-afaf-0c9e71a6b6a0",
"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-11-13T15:29:08.688854+00:00"
},
"modified_dateutc": "2026-11-13T15:29:08.688854+00:00"
},
"marketing_segment_id": "061ad2ef-0ad4-4b01-b024-c221494b7c63",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cacfc4a4-9f40-4b4c-acde-bfb49024c96e",
"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": "4ba7d756-e441-4e45-bdc2-51fb08d99d33",
"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": "f4913e5c-ec4d-4846-b7d1-24b1e9d2117c",
"db_country_code": "sample string 28",
"feelist_id": "fcb3a72d-e9ec-40d5-965a-af60c137bfde",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3f8ed4f8-031e-43fc-a7a9-71aedfaef58b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "07a5a9e1-1795-48b1-b5d7-43299f2339c1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-13T15:29:08.688854+00:00",
"db_currency_id": "b933eae4-2f8b-4b94-bde3-4534229262d0",
"db_currency_code": "sample string 10"
},
"company_type_id": "8a95ccfd-77f0-405d-8d38-6322fb7e7b50",
"company_type_name": "sample string 32",
"company_type": {
"id": "b9cd9b2b-ae2d-4545-a5b6-5ac11b068418",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8bdcec3a-7c72-4b2d-a74c-6ddfe9db01b5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d04e20de-08bd-4101-874e-3c939f830b0d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0e7a0bc9-bad5-4300-841c-3c13d3f3ff79",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9a3d12c8-4b94-4f3f-b14f-80a712406101",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bf506f46-3c81-4460-83be-f367def3d286",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-13T15:29:08.688854+00:00"
},
"company_sector_id": "e73526dc-680a-42eb-be9c-a8e1288984cf",
"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": "123e6954-4909-41bb-b327-f8f1a08468aa",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "faa8d618-fe20-41e1-9f70-fcbbc889f067",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "454e2239-6c8a-4fa5-ae46-287a38401ce9",
"account_manager_user_code": "sample string 56",
"company_status_id": "edd743cf-65e7-4f7b-b39d-76df281f3efc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-13T15:29:08.688854+00:00",
"id2": 60
},
"db_language_id": "85bb86e3-2796-4788-b05d-0aad68121922",
"db_language_code": "sample string 7",
"db_title_id": "d97a6bad-9c4c-46d4-8d2f-893a81c4bd9e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-13T15:29:08.688854+00:00",
"create_date": "2026-11-13T15:29:08.688854+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-11-13T15:29:08.688854+00:00"
}