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": "895796e6-1b20-4ada-83b1-b231cd1f3d03",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2c22b77d-9f3c-41ec-bc8a-60968be91be6",
"company_code": "sample string 5",
"company": {
"id": "9b7175c0-b492-439f-8542-f455cc9ea88b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-01T08:23:07.0472296+00:00",
"sales_territory_id": "a95eb62d-f572-4b70-870a-afe25a1d27c8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "20059b08-59b2-464e-bc35-5874f3d5ab46",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9a5bafa6-347a-4a2b-83f5-dad64ed0d949",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "af5baeeb-beb5-4828-bbab-8965929d70bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6cb6f2e8-5755-4d52-ba59-329b1a62c280",
"db_currency_id": "ebf93951-18d3-4819-992a-5228dd256656",
"db_language_id": "0bec68bf-f77c-49dd-bb7c-63a4983e1486",
"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-10-01T08:23:07.0472296+00:00"
},
"modified_dateutc": "2026-10-01T08:23:07.0472296+00:00"
},
"marketing_segment_id": "5c319e45-3ef6-4e64-a3a9-c4250aaba595",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "110b3145-2fce-4a10-b4c6-81008ead6f1c",
"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": "2f3d8d63-acaf-42c7-8f12-f7619a517068",
"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": "37cfaedc-0feb-4d22-8f63-0d619a387b21",
"db_country_code": "sample string 28",
"feelist_id": "d312612e-963b-45df-ba4c-221e387eaf21",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e94b1294-7e41-496b-8f84-fb32415448e0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f30f2bcb-4c23-408e-b76e-99c6c70b5535",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-01T08:23:07.0472296+00:00",
"db_currency_id": "89a31bfc-bc6a-492d-9e81-2916b4d50b55",
"db_currency_code": "sample string 10"
},
"company_type_id": "ee2d620c-820b-45e5-bf62-e4bb73866d40",
"company_type_name": "sample string 32",
"company_type": {
"id": "d06f1955-fc39-4f1b-b1a5-7f51a3e09956",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ab7ceb81-56b4-41e4-b406-3e30a1ea166b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a17aa9a0-5bc9-482e-97d6-ad4c138501b3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c1608d60-f3cd-4482-9326-da9c7cbb89d9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f195c310-1388-4f6e-b919-f2219b3a7aab",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ca2d9520-5868-4615-9363-afb8dee51f4a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-01T08:23:07.0472296+00:00"
},
"company_sector_id": "a2bbdb2c-29ef-4b95-93a7-fe944cb444ba",
"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": "e71bd194-6780-405c-bfc8-b9ae20746a6d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b8300182-948e-4d94-9130-a68c0404bed1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3f216560-546d-4875-95fe-f3ee13e65c8e",
"account_manager_user_code": "sample string 56",
"company_status_id": "44bf757f-76a2-40c3-9789-df69bbabba86",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-01T08:23:07.0472296+00:00",
"id2": 60
},
"db_language_id": "b9918bba-291b-48a4-86d3-6136516f3ec2",
"db_language_code": "sample string 7",
"db_title_id": "26e99d86-982f-4b00-a2e2-553e45ce89c5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-01T08:23:07.0472296+00:00",
"create_date": "2026-10-01T08:23:07.0472296+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-10-01T08:23:07.0472296+00:00"
}