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": "62e2ccfc-a9af-4ca9-8d84-b31ab6a8d029",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7054defe-c891-4180-82d0-0211f709031c",
"company_code": "sample string 5",
"company": {
"id": "ab66e69c-6223-4d78-b7a0-cf74153a07dd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-25T23:54:57.4553187+00:00",
"sales_territory_id": "e6beec43-1799-4344-8550-aaf1fda3b870",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e01353a5-b367-49a0-b299-bc18e7c840c5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "132669ba-d92b-4325-980c-f985a5012efd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a145f13f-4217-4171-a021-324b1e439589",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28052a50-0ef7-45dd-865d-6409e864eb94",
"db_currency_id": "2f49e8d8-47cf-4a55-90d1-4c3f004e198d",
"db_language_id": "69420541-4a48-47f5-9f18-48bcc5f161ef",
"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-04-25T23:54:57.4553187+00:00"
},
"modified_dateutc": "2026-04-25T23:54:57.4553187+00:00"
},
"marketing_segment_id": "def501f3-58dd-4992-b85d-581261686bf1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "297ed4ed-6b47-43b9-9133-30e8e23b66b4",
"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": "babfc2fb-b0e8-49b6-a5f3-81a5a45e091e",
"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": "5d6cee84-546d-440a-bffa-f792921bedf6",
"db_country_code": "sample string 28",
"feelist_id": "3271dc7f-8b58-48bb-adb6-27e89dea637c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3b00d079-d47b-4298-bab0-4ae6bbbcfb89",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dc77dffb-bcf1-491d-9d21-b4ef02a97a0a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-25T23:54:57.4553187+00:00",
"db_currency_id": "7a98f1f3-b8fc-445a-b80d-8e0f31950b16",
"db_currency_code": "sample string 10"
},
"company_type_id": "a31ceba3-63e2-4c81-abd9-a3e1650b9a41",
"company_type_name": "sample string 32",
"company_type": {
"id": "653e166d-673e-49ce-8852-3c671c416f4e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5e53e5a7-05ce-4941-9633-3f4d52c7aa0e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ebabe18e-d439-4faf-ba65-9e0ea14d2074",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "741029c5-45ee-45a2-9d32-cb8e9c0da71f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cd2fec04-07ec-4b03-9563-66e1e208e0d3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "12c23f51-f4df-4120-aab4-03e0b92e7f2a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-25T23:54:57.4553187+00:00"
},
"company_sector_id": "3463556a-1858-4fdf-ad9f-c795b8bc5941",
"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": "23b6fe4c-2f6e-4691-b669-cbbaa2684666",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1ec512b3-f907-442a-a283-37cad14128e8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e31e319c-1181-4e59-865b-a927b3d71fd8",
"account_manager_user_code": "sample string 56",
"company_status_id": "14a11d42-33d5-4aee-836c-65a8635ce033",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-25T23:54:57.4553187+00:00",
"id2": 60
},
"db_language_id": "d78164f6-d920-4295-ac9b-4b90bf99bec4",
"db_language_code": "sample string 7",
"db_title_id": "4120c283-ccec-48f2-8b2a-6e69073d19d1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-25T23:54:57.4553187+00:00",
"create_date": "2026-04-25T23:54:57.4553187+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-04-25T23:54:57.4553187+00:00"
}