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": "75c37be8-599e-41d1-a031-e97123346c42",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b94cb445-62f7-4a32-aa09-667ac5956d08",
"company_code": "sample string 5",
"company": {
"id": "b3527cc9-7595-4d0e-8785-fa370f3746e1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-10T19:41:04.5379065+00:00",
"sales_territory_id": "c9c96171-39bf-41ea-9a3a-acce0e0901f4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5482ec8f-2674-45ac-b84a-17fabde3ade4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5eb3dee4-4367-4b59-b42a-bf5bd23652a4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6dcef869-3237-4430-80e4-28eb9a70399c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f6d3069-ed65-4df0-a5d2-a3affc8709dd",
"db_currency_id": "046bd571-b42b-4aa3-ab63-31ed645f83b5",
"db_language_id": "0fa37eb3-5659-48ae-9288-d7761f711a89",
"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-05-10T19:41:04.5379065+00:00"
},
"modified_dateutc": "2026-05-10T19:41:04.5379065+00:00"
},
"marketing_segment_id": "02fd105b-37dc-40c1-a478-765f901baa3c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6453308e-1f2c-466f-8d47-e81c5409708b",
"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": "c920b0f3-3657-4644-9cf0-2a05a9fe74af",
"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": "bb5dda80-5978-4f97-b571-ce21cae27967",
"db_country_code": "sample string 28",
"feelist_id": "8e0653f5-05ab-4ae6-9812-3be74edb4e29",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ed964123-84af-4ab8-8abe-50df1845cd8f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c0c5ead5-3122-4dc3-b7cd-1db9e72118d0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-10T19:41:04.5379065+00:00",
"db_currency_id": "1cea75a7-783d-4dd8-8687-1583439333f1",
"db_currency_code": "sample string 10"
},
"company_type_id": "d0fc2d08-b89e-40a1-8195-0222357fce60",
"company_type_name": "sample string 32",
"company_type": {
"id": "853fa5fd-6ed7-411d-8269-78f8accac939",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c7dc1bff-3289-43da-90dc-2cc1b0127029",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d251194e-252a-4cbf-947f-90015064b79b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "562b5d44-4799-4773-a3dc-4fec7aad3ea5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f325859f-8a6f-43bb-bce9-74f3d9727115",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "691e0443-c63c-4ba2-b44e-ef8ddf3e3766",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-10T19:41:04.5379065+00:00"
},
"company_sector_id": "5011a197-6ac7-402d-b67b-e79bf56e0a1b",
"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": "399a53e7-7cb2-4a94-b448-6572bdd8ebff",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "380756ba-c316-4b01-bd61-be49e25f8c4e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a483ca33-0ed3-4eb2-a726-f0051ecc0afc",
"account_manager_user_code": "sample string 56",
"company_status_id": "2d9471ff-75f8-42cb-9703-0eb83ee41150",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-10T19:41:04.5379065+00:00",
"id2": 60
},
"db_language_id": "76615454-56c4-4afc-856b-ac6c01769d9a",
"db_language_code": "sample string 7",
"db_title_id": "019524ad-09ba-446f-8ac0-019edf59a1c0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-10T19:41:04.5379065+00:00",
"create_date": "2026-05-10T19:41:04.5379065+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-05-10T19:41:04.5379065+00:00"
}