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": "98ad691d-19a5-460e-98b7-e135c068e16d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4afc588c-e2aa-4902-8f18-65d5b96403c5",
"company_code": "sample string 5",
"company": {
"id": "3a3cb6d0-1662-4bb8-b75d-addd1eb87f41",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-07T00:31:45.746683+00:00",
"sales_territory_id": "d2556c56-ab43-47a1-bd10-ef3ca2ff5c91",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "16060aaa-d28d-4532-a824-84f66227b8e1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a22bffc1-6470-4254-861d-7415b0abe6cc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8b87f443-89ca-41b6-af4d-3f92a65ded14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fd62ffc-31f1-4bbc-b437-984064108adb",
"db_currency_id": "dc97f0de-b620-4089-b076-a88c5b479282",
"db_language_id": "87471b33-6a0b-40a7-8c08-f9a46e70e9b1",
"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-03-07T00:31:45.746683+00:00"
},
"modified_dateutc": "2026-03-07T00:31:45.746683+00:00"
},
"marketing_segment_id": "d5220466-20dc-47a7-8a26-b21cca2bb16d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "23db9ac7-b098-4d44-8322-b1ea8053f92a",
"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": "b66b7da3-9a61-4767-b76f-dd82f6647efe",
"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": "5fff8fda-b35d-4ca0-9730-6f6e7f82fbd3",
"db_country_code": "sample string 28",
"feelist_id": "8951705b-5acb-46b0-82a0-2c38b25e89e1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e2305b5f-d992-498a-a049-727dcc688c02",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dd899e2e-9220-42cd-8384-d37e6b00e639",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-07T00:31:45.746683+00:00",
"db_currency_id": "bc21eb34-b776-43f4-80cf-807ffc6ca672",
"db_currency_code": "sample string 10"
},
"company_type_id": "2a2971e3-f75c-4b58-9005-fbd5dba1f335",
"company_type_name": "sample string 32",
"company_type": {
"id": "0624b948-d35e-4008-ad20-28c26772540d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "df21face-9d75-4870-87a0-5e560b9fd3f3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4e489cd8-bf61-402d-835f-952a2f195508",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "24c640d5-aaf9-4c9c-8fb2-7078d38669c7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c9935abe-2578-4b43-87a6-1111720fd0c1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f76f1617-562f-414f-8dc2-0ac52394ee42",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-07T00:31:45.746683+00:00"
},
"company_sector_id": "59a6214d-39ae-48f7-892f-e27d097a07fd",
"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": "bf1b6944-a238-4589-ad72-7bf19704cd0e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d45a295e-8d12-4a2d-ad3f-f13d8bb9f76d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5c5be7cf-8b86-4dbd-94b8-53d75e740339",
"account_manager_user_code": "sample string 56",
"company_status_id": "074984f5-42f7-4f3b-afbd-d785c24ca596",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-07T00:31:45.746683+00:00",
"id2": 60
},
"db_language_id": "1ad0b5ef-b5ac-4f6d-af5a-840002151e11",
"db_language_code": "sample string 7",
"db_title_id": "df99f917-e658-438f-a5fc-973bc4d08c70",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-07T00:31:45.746683+00:00",
"create_date": "2026-03-07T00:31:45.746683+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-03-07T00:31:45.746683+00:00"
}