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": "d22e9fc1-e76d-4f89-81e0-f7e362ffd7fe",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6a6cfe89-8c1d-42ca-9cb9-77404f1fbaca",
"company_code": "sample string 5",
"company": {
"id": "b7ba6d93-1ede-4256-9dc3-ebbe6f5669cb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-07T13:53:00.0404062+00:00",
"sales_territory_id": "650b64c7-993a-4f02-ba88-33b128bb6710",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c8412fa8-5079-4bd7-a416-c01b60ad81a2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "efa49db5-3b46-4703-b0be-72b9abbec8c1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "379a5d13-cf17-489a-adeb-626311384888",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2da44fc7-51f3-41de-b02f-d240e251da37",
"db_currency_id": "45c3b691-fe15-44c4-8f53-b5c5cfa3b8e4",
"db_language_id": "fbf72ddf-6a8d-4b41-8c4f-2c32ecb57960",
"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-10-07T13:53:00.0404062+00:00"
},
"modified_dateutc": "2025-10-07T13:53:00.0404062+00:00"
},
"marketing_segment_id": "f17a1561-bc7c-4a41-b48c-75d055ea2604",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "86e305bf-044b-4ae1-a639-d75dd67c136e",
"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": "bdeb18a4-68e8-4697-b9d9-dd64320f50fd",
"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": "2a383f1e-2cf0-4b3c-8e9b-ad1f8f6384e3",
"db_country_code": "sample string 28",
"feelist_id": "a6814f43-979f-4dac-9cc8-6818c0fcd742",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4327a2a9-6e27-4496-9be4-d88432323539",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5aeec25c-c32b-43ca-8956-e72f01a88a10",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-07T13:53:00.0404062+00:00",
"db_currency_id": "e13a015d-26b2-423f-80ea-35dafc51b2af",
"db_currency_code": "sample string 10"
},
"company_type_id": "99f474e1-0f64-436c-aa34-04f0f532fdbc",
"company_type_name": "sample string 32",
"company_type": {
"id": "cf7d76cc-c86d-414b-a63b-b78a316eb341",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a05a84e1-10b7-4087-b649-0a7d34a1cdb9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "84536133-967d-4965-9dc1-cfdec6595f4f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b5b6777a-b970-4bd9-9a10-aa6f9cc842ca",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f62ae49f-0170-4451-ae78-973c3b3843b9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "98d788a1-af83-41e1-98bc-02f289b0f668",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-07T13:53:00.0404062+00:00"
},
"company_sector_id": "1ae091e7-a6a1-42f3-a57d-167837b3a1a9",
"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": "ddef8dcc-f063-4a99-8189-e4a2aeaebd88",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a6105550-35b7-4289-bc77-9a36e8461862",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b0993dc3-1b91-4d68-bf54-b6e584c51652",
"account_manager_user_code": "sample string 56",
"company_status_id": "e265078e-de56-4af3-a819-2dd0089740a4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-07T13:53:00.0404062+00:00",
"id2": 60
},
"db_language_id": "484c1033-fdeb-4dc1-8f60-713191ca9c8c",
"db_language_code": "sample string 7",
"db_title_id": "339ff832-9fbb-4212-a987-a2fb58eaa694",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-07T13:53:00.0404062+00:00",
"create_date": "2025-10-07T13:53:00.0404062+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-10-07T13:53:00.0404062+00:00"
}