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": "51a6bab8-9c7a-4585-a516-eece301b31e3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a7014cb1-0067-4d05-af95-71832d92eab5",
"company_code": "sample string 5",
"company": {
"id": "6b878f3e-e81e-4070-a60d-a0a59006561e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-11T19:04:07.8556492+00:00",
"sales_territory_id": "e8757cbb-cd5d-4943-be53-815255e2070f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "73dc17b4-b259-4de8-a52c-bb72806d771c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "26ad7c3c-7999-4e14-a6fe-e5e97a39c5c3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "90d976f2-6b64-437b-a225-f2f3f442a447",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef872b0a-634e-405e-9e19-e1f974bf14f4",
"db_currency_id": "0ebd8eca-b969-4da7-9c59-7b4d492dbce6",
"db_language_id": "73ea5b08-fa88-4ddd-b1a8-b547ad0b067d",
"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-12-11T19:04:07.8556492+00:00"
},
"modified_dateutc": "2025-12-11T19:04:07.8556492+00:00"
},
"marketing_segment_id": "f6c95d69-18af-4e5f-8278-d3e27567cca5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2d6fd95c-bd17-4d79-8d82-dfa3652d73ab",
"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": "be35e77c-82d1-462e-9112-d1149b0b373e",
"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": "f6757909-2bcf-43b7-b566-f11c3513e4cb",
"db_country_code": "sample string 28",
"feelist_id": "6270c37b-b038-4aef-9528-8f43dfc94b8a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4a11a8a2-e0aa-44a1-b8e3-595117ea127b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "67c36b3b-9c5f-449d-8242-15d0a5ea9717",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-11T19:04:07.8556492+00:00",
"db_currency_id": "8184b359-39d3-4e05-8e54-f3d3ba1accd9",
"db_currency_code": "sample string 10"
},
"company_type_id": "5d21d73c-3574-4b69-9a3b-a18648844f04",
"company_type_name": "sample string 32",
"company_type": {
"id": "e4ceae83-1bec-4eb3-b60f-bbfa4cfde0a8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "13340ec6-3138-49d7-bce2-656da6085123",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b7fd58fa-721c-49b2-ae90-bf5183733792",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3ecf028e-e7ba-4b8f-8143-378e7102bb90",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c125ca3a-045f-4ec6-a780-4935ef8a27b6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e6cdb2d5-c906-468b-80f6-fb57b1366862",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-11T19:04:07.8556492+00:00"
},
"company_sector_id": "c3fa66d6-a422-4088-a593-5cb2e600f872",
"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": "7fd67c26-a3d5-465d-a80a-2aa221158915",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bb7ddb07-9497-4b0a-8bd8-c6fd7b16cc0e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0a4e5d3c-62f4-41a6-b28e-baf1d31935d6",
"account_manager_user_code": "sample string 56",
"company_status_id": "4b524091-64e3-48b2-8da5-682cde6ead46",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-11T19:04:07.8556492+00:00",
"id2": 60
},
"db_language_id": "95547dd2-184f-4fbc-8d4e-b27c0a51661c",
"db_language_code": "sample string 7",
"db_title_id": "6e0ff16c-d055-420a-9cc7-74afd26b63a2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-11T19:04:07.8556492+00:00",
"create_date": "2025-12-11T19:04:07.8556492+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-12-11T19:04:07.8556492+00:00"
}