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": "f4b77449-7bcb-45d9-90d1-ea9ae630cc6b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "de6100a8-7127-43bb-a5f8-387d1cd9966a",
"company_code": "sample string 5",
"company": {
"id": "fa2c4935-024c-4d73-b9e6-9919bfbfec82",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-10T04:57:02.3581028+00:00",
"sales_territory_id": "7524cdf6-24b8-4e81-bfc0-16ca04177b7a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9ca00faa-6c31-4f33-b8ef-2c2f6df22320",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "52272a3f-009c-4797-9c9b-0c6718fa4e18",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fa2801bb-f7f3-4bdf-99de-f44f07263932",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c421b09-1ee9-4f4a-a9d8-0ac8f2fd855b",
"db_currency_id": "8f8d3c74-61ef-4b3b-b40b-21ba1184808f",
"db_language_id": "ace91793-0625-40d6-85da-5c95dfbf3dae",
"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-10T04:57:02.3581028+00:00"
},
"modified_dateutc": "2026-02-10T04:57:02.3581028+00:00"
},
"marketing_segment_id": "2e1ce2fc-2ed3-420a-9636-0b5417f86001",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7115f67c-4a0b-4279-8f11-58e55198e2b2",
"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": "70aca2f4-6f54-49bf-93db-8673b5aa8b86",
"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": "5c882158-843e-484a-bc95-1aa3bbd32ae1",
"db_country_code": "sample string 28",
"feelist_id": "c4d2e063-fa5f-4061-b0ee-8981f5c76244",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4f961d7a-d3a9-4f63-b6e4-e7784e40fb33",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "aa4fd51c-8830-4970-81e1-ac0464db4c3c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-10T04:57:02.3581028+00:00",
"db_currency_id": "98f2a735-0977-44cc-b1e6-f04931f73f2e",
"db_currency_code": "sample string 10"
},
"company_type_id": "82e34b46-749c-4770-9bcb-5b22821d0cec",
"company_type_name": "sample string 32",
"company_type": {
"id": "f365e7b1-f960-4ec8-8678-c9444eabaa77",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "afd26ee1-a3ec-41e3-94e5-d238a7a00c3c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5267b822-5af1-4837-94b9-0962c8bbdd7b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9dd610d6-c7bc-4ad3-8622-1c8e391ddf68",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c923bebe-337f-4a6d-a2dc-5a1425991f01",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ca34a969-6b6c-4387-b476-c31371f65e6c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-10T04:57:02.3581028+00:00"
},
"company_sector_id": "0bab1dc0-0f55-4082-8942-f93be79b8979",
"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": "7cc2877c-2845-420f-a080-e279b24a84a4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "393434f2-0414-4d41-a1eb-f10e75f4c18b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e487847c-b846-4939-a399-c20babd96771",
"account_manager_user_code": "sample string 56",
"company_status_id": "a74d0d84-1a97-4fef-b2ad-aa979dabf3c0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-10T04:57:02.3581028+00:00",
"id2": 60
},
"db_language_id": "5a146483-b353-4940-83e5-37839c21fe0e",
"db_language_code": "sample string 7",
"db_title_id": "b48da7a0-da34-41b4-b024-0611a7b1f92a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-10T04:57:02.3581028+00:00",
"create_date": "2026-02-10T04:57:02.3581028+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-10T04:57:02.3581028+00:00"
}