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": "41dc3c11-f365-40c1-9684-8c41e5278751",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cf41fc03-bf3c-4881-85c7-1a0a43d3512e",
"company_code": "sample string 5",
"company": {
"id": "a16d7f71-a069-4b5a-b2ca-491a5a1286d1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-19T10:11:51.7608773+00:00",
"sales_territory_id": "146b4b29-1d53-41ad-a39e-6d2661a3391c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4c6c5103-5599-479a-9a98-a03181c0f678",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a9d5df1a-d83c-4580-bd74-7fa5a893f27d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1f121d15-468d-43c4-9c82-c5a920188bfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb3fa0fa-883c-4886-a327-10a370551f17",
"db_currency_id": "95f9e3d5-78ff-4ea7-9b4e-c5c5bdc939c9",
"db_language_id": "ca364ebe-553b-413b-8a44-c3f406278aa1",
"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-19T10:11:51.7808171+00:00"
},
"modified_dateutc": "2026-10-19T10:11:51.7808171+00:00"
},
"marketing_segment_id": "3abd8b6d-c449-4f1c-bd9d-ac13b6f35a9e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ec9238d6-6a8e-49fc-a36b-d93f367898ab",
"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": "5d8e5149-740a-4c11-b3a4-1e08f3096966",
"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": "e4508c74-dd83-4247-a45e-65bcff9c60c6",
"db_country_code": "sample string 28",
"feelist_id": "3b64b9fe-345f-466b-9634-cb2781092f4b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a5b43ca3-cdb4-4d87-8048-a5c2813cc588",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0ab249d7-a187-4795-912f-2e7c5d77093b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-19T10:11:51.7808171+00:00",
"db_currency_id": "7b1357ff-cf8b-4593-bc63-8f0aeabda849",
"db_currency_code": "sample string 10"
},
"company_type_id": "ebc8c2d5-fa92-4055-82cd-8ed7be0085a8",
"company_type_name": "sample string 32",
"company_type": {
"id": "62099d5e-dc6e-40ca-9d2a-58bce55fe14d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c520f029-8bad-4198-a965-f636b80e0a08",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ae6b2178-8000-475c-b675-256954af2e24",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "227dea82-d28b-4382-bcb6-09c22334f8dc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3468549b-16c4-41c7-a7d9-c09e2e383b90",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c29725ab-71cc-4e62-b092-11ed392e1ae7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-19T10:11:51.7808171+00:00"
},
"company_sector_id": "7ab0c3d5-e851-4365-9576-ff906dfad852",
"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": "1875ae56-c5da-4fc7-a752-36307ee406aa",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a609c3ed-fb67-444b-806f-7f898a49947d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dcd62761-381d-499c-b701-a0cdf240ba4e",
"account_manager_user_code": "sample string 56",
"company_status_id": "1a119505-30e7-480f-9588-7e6496fdd094",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-19T10:11:51.7808171+00:00",
"id2": 60
},
"db_language_id": "51a8371a-3ca6-45f2-a960-01248c916ff6",
"db_language_code": "sample string 7",
"db_title_id": "e246b818-a9f0-414c-aaca-b3bacca42e66",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-19T10:11:51.7808171+00:00",
"create_date": "2026-10-19T10:11:51.7808171+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-19T10:11:51.7808171+00:00"
}