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": "be1000e6-5667-4c6d-a441-13bddf5108e8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9baa42a0-14ec-4427-bc20-f18c1f2faf0d",
"company_code": "sample string 5",
"company": {
"id": "97788636-4916-44dc-a69c-ab716c127b4f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-23T22:27:40.7007156+00:00",
"sales_territory_id": "fd84e59b-6176-4735-a476-c8f45655fac0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d71ae2ce-631b-43f1-9c90-189f56cf4dbb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c2f72d2b-bd98-4841-86f3-853691121451",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e433e81f-c782-4247-883d-f06feb22619c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10552fd0-6262-4751-95de-7b5f1120065a",
"db_currency_id": "6d396486-d032-4bf9-b56a-160a00a00bbc",
"db_language_id": "fb06bc12-fcde-4c14-ad5d-c4cb9b1974ed",
"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-07-23T22:27:40.7007156+00:00"
},
"modified_dateutc": "2026-07-23T22:27:40.7007156+00:00"
},
"marketing_segment_id": "52668163-089b-48e2-a6e5-9a1a7ff7a8ba",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "56ee4cd9-13be-43eb-a6cf-0e529708b37b",
"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": "de1e5707-7104-4c87-bdb6-4d507f134e6b",
"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": "16d787ea-03db-4420-ab59-7f56b2772e45",
"db_country_code": "sample string 28",
"feelist_id": "1918558f-46ec-4050-a8b7-b9836e9afbb8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a3fe8fb4-7364-4023-aec0-1a53ab7fe1e4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "77d3ab25-5534-4abb-8734-b3a18778c41f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-23T22:27:40.7007156+00:00",
"db_currency_id": "7cc76ed4-5a25-461d-af55-adfad362defc",
"db_currency_code": "sample string 10"
},
"company_type_id": "bf61740a-d6b4-4ff2-980b-43f81dbc95e2",
"company_type_name": "sample string 32",
"company_type": {
"id": "588813bd-5018-4152-a70c-4daf677bca77",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "19a8f75e-1a4d-4762-b280-2cccfb9e14c8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c241ab41-d4f4-44f4-ba4b-314833ece8de",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2f1a4823-e83c-44a0-a484-668f3a10e0bb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8425d102-0270-42aa-974c-5a790a6263fd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c1199cff-ee6e-42f7-9f35-fba756d2a031",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-23T22:27:40.7007156+00:00"
},
"company_sector_id": "66e4dcbc-ba4a-4ca5-9502-6402772b6df0",
"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": "aff876c3-eb27-49be-85b7-c94e5f43c159",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "04335426-90f9-4525-a627-f478d62a426e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4f1799b5-18c9-48b6-8fc2-a091c1a58d9f",
"account_manager_user_code": "sample string 56",
"company_status_id": "9a8c59dc-03ec-4240-9852-732cc9f92907",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-23T22:27:40.7007156+00:00",
"id2": 60
},
"db_language_id": "b33ecf0e-8703-450e-8a1f-b1812e4d75d0",
"db_language_code": "sample string 7",
"db_title_id": "b0da1e5f-385e-45e2-96b2-0b67cf654cb7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-23T22:27:40.7007156+00:00",
"create_date": "2026-07-23T22:27:40.7007156+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-07-23T22:27:40.7007156+00:00"
}