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": "bdcd1010-af0b-4e6b-ba2f-0c88ed5f0ed1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "81d709b7-a2e4-446d-ac75-3067d9025a53",
"company_code": "sample string 5",
"company": {
"id": "8c35edd6-16fd-42a2-897c-f1e1c41c39e4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-08T15:09:12.327808+00:00",
"sales_territory_id": "975171c9-f4b8-4a27-9976-eecf43c59283",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e36d55da-8b3e-4b20-8e32-c945848cde85",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "abc52c44-6829-4783-a683-a86a6ed6a06d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7161c688-cb70-4db4-aa00-2e2e7b419d72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fae8322c-007d-467f-b2e6-afb24a5f48e3",
"db_currency_id": "43bcfa5b-98ba-4385-bcc0-251594c9cdd3",
"db_language_id": "fe294b40-ce6f-4723-89e7-cff9040d1b63",
"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-08T15:09:12.327808+00:00"
},
"modified_dateutc": "2026-02-08T15:09:12.327808+00:00"
},
"marketing_segment_id": "07fb03bd-cd12-426f-96b5-31b7b4504b68",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ea89e96c-74d2-4907-89ee-972f5c2f7218",
"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": "db6dde25-1025-481e-96fa-098785885e55",
"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": "af57b158-9b51-41cf-aebb-89038d71d63e",
"db_country_code": "sample string 28",
"feelist_id": "a7b1b346-60d8-4048-8fc7-6f10037ae4ea",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8f19df37-be9c-4917-98eb-ca0146eff30e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1aa90f41-486a-483f-a79d-1f8a017a27b6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-08T15:09:12.327808+00:00",
"db_currency_id": "7843e79e-8d77-4e11-bc3a-498c3f6fb4e6",
"db_currency_code": "sample string 10"
},
"company_type_id": "ee123f6d-d687-4520-8f4d-f09799b6e009",
"company_type_name": "sample string 32",
"company_type": {
"id": "f2213218-46e9-4f66-8a90-66edd66c9185",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "647ccc8e-d9a2-4f72-92b2-5cfa5d0a1c6b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8f1c51a9-9090-419a-bb47-0fe3cc1fe041",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a645a625-9c71-4913-908a-39a89d60af3e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "68a287f8-5e2f-4ef6-ba4d-162a182489a9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ac0bf1ce-ce3f-41b5-86b8-693f6c045bfe",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-08T15:09:12.327808+00:00"
},
"company_sector_id": "c5957ac2-6bdc-440d-be17-f5817d665d1b",
"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": "9bc70d45-aabe-4df9-8e58-ac544b16d1fe",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6a123e56-c04f-4e07-9389-45f7d9bdf8fc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "25e91aa9-a8f4-4ad7-9c9c-35b03d9cfa5d",
"account_manager_user_code": "sample string 56",
"company_status_id": "b9b63837-79a1-4a70-951f-cc17e808bdcf",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-08T15:09:12.327808+00:00",
"id2": 60
},
"db_language_id": "9aa52362-5e40-486a-8175-2ff974d545d1",
"db_language_code": "sample string 7",
"db_title_id": "d5f75425-acfb-4da1-a637-a6f514277eaf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-08T15:09:12.327808+00:00",
"create_date": "2026-02-08T15:09:12.327808+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-08T15:09:12.327808+00:00"
}