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": "f6bfcff3-9212-48a5-965f-86a852275ce4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "efb0a10a-8e6c-43d7-ae89-bca0061b68ab",
"company_code": "sample string 5",
"company": {
"id": "cc538379-a817-458e-9e97-5f01671479f0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-03T13:56:46.0040105+00:00",
"sales_territory_id": "81793d2d-1268-4135-8fd8-dfb85fdb90d0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "906c5080-2f39-4b4b-bd8d-c6bfb5e3e232",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c4aa720e-d75b-42ed-8025-1d2cd3d13048",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a48c21db-a943-4e0d-a273-506f97302a9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "418d55de-be7f-4de3-9c0a-7d0e2b06dbb9",
"db_currency_id": "2544103a-daa8-4060-95ad-1f3cd6f5dd5d",
"db_language_id": "1a59d513-58c2-482c-ae57-0ce32cac3058",
"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": "2025-11-03T13:56:46.0040105+00:00"
},
"modified_dateutc": "2025-11-03T13:56:46.0040105+00:00"
},
"marketing_segment_id": "c3412da8-fb12-40c5-ab89-24492d3be8fa",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f4d46574-e691-48d2-b5ce-dced39b97e0c",
"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": "5684931b-bb31-46c5-9b97-4a5d631fc90b",
"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": "68b7bf21-5ed3-4c81-a5b2-08bf896088e2",
"db_country_code": "sample string 28",
"feelist_id": "ff20ba5b-1839-4157-9096-61a1e7210ae9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c413c560-9843-4885-9759-8e40b2219597",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5f6aa2be-f3bd-4837-aa14-7bb577524b97",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-03T13:56:46.0040105+00:00",
"db_currency_id": "47e26a26-2349-4c65-9feb-d397e7a88b5a",
"db_currency_code": "sample string 10"
},
"company_type_id": "e8dbd770-f059-433c-a615-9350d2d72315",
"company_type_name": "sample string 32",
"company_type": {
"id": "0358d814-a0a4-40c9-9229-4072c326853d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "00c4f5bc-54d4-4190-bd4f-914f9999788e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5bc9982b-3a32-4eee-a27f-46ad325b41f8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d03370d5-0ac7-4142-9eb3-716d1bc50470",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "45057a18-c988-4aca-a47f-c03058c8059f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "07e3c51d-016e-418e-8630-564158f94dff",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-03T13:56:46.0040105+00:00"
},
"company_sector_id": "23c45d25-5e0e-42c4-b0cd-bc399b1df11d",
"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": "5cb36b27-8af7-4d80-9204-c22c2820a6f5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c7a77608-558e-446b-8887-4445011f4d21",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8abc23c2-a9bf-47eb-8071-9f0eb4c819fb",
"account_manager_user_code": "sample string 56",
"company_status_id": "93c7a2bc-60a5-413c-8354-233e2e16a0d5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-03T13:56:46.0040105+00:00",
"id2": 60
},
"db_language_id": "9e4b6151-b99f-4fbd-b36a-e30b5a538ca7",
"db_language_code": "sample string 7",
"db_title_id": "539bedeb-b7e7-4d47-bd69-8db300d3fced",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-03T13:56:46.0040105+00:00",
"create_date": "2025-11-03T13:56:46.0040105+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": "2025-11-03T13:56:46.0040105+00:00"
}