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": "5cd42057-478e-491b-9b4f-fc39645ff9f3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1614111d-56ce-499f-9914-cb67c736c421",
"company_code": "sample string 5",
"company": {
"id": "c23b8a0c-71dd-4508-9349-dd5fee5aa5ff",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-11T19:41:42.3991008+00:00",
"sales_territory_id": "bf264688-a4a0-49f1-b618-eba0b2db37be",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2d50f38a-927c-42b1-9520-a7b8b9682709",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "381a2492-6e58-414f-a756-83d37f135231",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8132a4ce-98b6-4805-8471-6b8c1973d3eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57130a88-b0d7-4be8-a135-d4fd660b0730",
"db_currency_id": "6b6a8151-aaef-4318-a7b7-106fd9245988",
"db_language_id": "f0859ade-5e91-48d2-b6e3-81a34eff34c9",
"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-09-11T19:41:42.3991008+00:00"
},
"modified_dateutc": "2026-09-11T19:41:42.3991008+00:00"
},
"marketing_segment_id": "00e6411c-a787-4e6a-8e00-306fbf0ecee0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "aab622ed-380f-4e1f-8e4b-7eed88dc74a0",
"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": "ff1ab605-032c-49ff-ad54-169689030514",
"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": "31411785-35de-4a15-89f4-28d802920399",
"db_country_code": "sample string 28",
"feelist_id": "b519f2b7-ac66-4604-9599-1be48d8ed65b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "14aa8af6-4131-46b9-8417-8ea7f8d94729",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b66b332d-2c97-4ec3-a6e6-62a2de667a84",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-11T19:41:42.3991008+00:00",
"db_currency_id": "26c03e9c-e92a-48b5-b9ee-00134bb14f18",
"db_currency_code": "sample string 10"
},
"company_type_id": "5a8d87ab-67b0-432d-883d-f3561ad978fd",
"company_type_name": "sample string 32",
"company_type": {
"id": "5fdb4e16-7253-4674-aacf-8942e7d6727d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b900e5aa-c35f-4340-990a-6e776c173832",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7a7b4463-e42e-43b7-97a4-9915f90bbd3f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "18456c9b-2330-4a86-9e66-0b0a9337d2d7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "25eaa0b7-786e-44d4-868f-0bb59f628ac5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5875f9ca-5534-49f1-bfd3-09078f5ec2dd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-11T19:41:42.3991008+00:00"
},
"company_sector_id": "06dde9a1-d6d6-431a-a518-62a570def04a",
"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": "4def5aa3-5242-4f68-a78d-5cc135d7d8c2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dcb9ce42-979b-4325-9e16-faac8b41126e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1ba31c2f-0f9d-4592-a678-ad2919cf384d",
"account_manager_user_code": "sample string 56",
"company_status_id": "f1f80432-bebc-4592-9975-bac4b95708b9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-11T19:41:42.3991008+00:00",
"id2": 60
},
"db_language_id": "9f7ad3c1-f7ab-4d9c-9a43-b300ababa2af",
"db_language_code": "sample string 7",
"db_title_id": "6c52fa0d-54be-4ff8-8c3c-37ef642d90bc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-11T19:41:42.3991008+00:00",
"create_date": "2026-09-11T19:41:42.4147228+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-09-11T19:41:42.4147228+00:00"
}