Retrieves all the company contact
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
{
"id": "a6b667ce-4a46-4d5b-a4c3-ef00d4821ce0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "348be965-f283-490b-852e-9ee2e4e8037f",
"company_code": "sample string 5",
"company": {
"id": "b47e0431-474a-4222-b06e-1e5c562e50c4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-07T10:25:06.3682768+00:00",
"sales_territory_id": "db641bd9-1403-4ff6-9545-6d51b33aefa0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f10889a8-c78c-4587-bdc2-bda8dbfefb95",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "da8b7449-0469-4ee1-bb6d-f11986868d6f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3b8edcbf-f723-4dda-90bb-246e568fec7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74d5c230-9b81-4206-b235-4e4fbf0ddc3f",
"db_currency_id": "7593eaff-9482-4ff4-83d4-a25a3dbfcd7a",
"db_language_id": "f9986821-3083-4053-96bc-9740990de41f",
"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-11-07T10:25:06.3875447+00:00"
},
"modified_dateutc": "2026-11-07T10:25:06.3875447+00:00"
},
"marketing_segment_id": "fa295576-9225-45e6-a5f7-b5dfe95cade8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "79fc2994-e03d-46e2-af5f-37cd905cfbaa",
"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": "330bbf54-545b-4dc7-8bf7-41eade9754fb",
"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": "74bbf08b-9b7c-4c6c-801d-f2b28405b538",
"db_country_code": "sample string 28",
"feelist_id": "8bf9ac56-654a-423a-8523-a29e2aa92fa7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "07b92226-a6bb-406b-afd7-27334720ea2b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "57311eb1-cbde-4c20-824c-d43da598dfb5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-07T10:25:06.3875447+00:00",
"db_currency_id": "ea6d09f6-7183-403f-a38f-4de2bda0e560",
"db_currency_code": "sample string 10"
},
"company_type_id": "34caf4c6-36c5-4599-acc1-8d99e707cd68",
"company_type_name": "sample string 32",
"company_type": {
"id": "bece94fb-81d0-4af8-bce6-86f7565fa314",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a6b671cf-1af6-4866-be0c-8b72e90ca780",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ec7df3ae-d690-4493-adb6-866e0ff6dd40",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bf841543-3bc0-43bb-9dab-c82ef442fa79",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "92394621-8cf0-408a-9ce0-0e8a614a2f93",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b8a0c863-dc84-44b2-b881-5d3886543c82",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-07T10:25:06.3875447+00:00"
},
"company_sector_id": "60eb5d21-02b0-4db9-bae7-c59601524171",
"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": "ee4465c5-8dc4-4360-83e8-c5a05e88e753",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "59e581da-4f57-4eb7-bf13-794430cd56a7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f9f83453-852f-4da9-a10b-3b46f3712b44",
"account_manager_user_code": "sample string 56",
"company_status_id": "69dfc027-4542-45f9-b120-30cd91840cb8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-07T10:25:06.3875447+00:00",
"id2": 60
},
"db_language_id": "5296e05c-bb9a-4bd0-bd44-738630c4a443",
"db_language_code": "sample string 7",
"db_title_id": "a616b836-e314-4c58-8c16-5f3c7bb57fa9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-07T10:25:06.3875447+00:00",
"create_date": "2026-11-07T10:25:06.3875447+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-11-07T10:25:06.3875447+00:00"
}