Retrieves the company contact with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "08bbc510-6df4-413e-9819-e4a108397ca8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a652a647-5bb7-4e79-97ee-151d8540a685",
"company_code": "sample string 5",
"company": {
"id": "2167d889-479a-48ea-ba4e-44a1a32371a5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-04T14:39:09.6467731+00:00",
"sales_territory_id": "695ad36b-3db2-4682-b508-24e72b20775a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bf120804-2ff6-4716-986d-707370cfb7d8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0de774dc-88ef-4286-ad11-a7c1f4c34a76",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1d3b1dda-6bf9-4a34-9dbe-404067ad4c1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87d4311b-3801-4f5e-a36d-5e80db053f62",
"db_currency_id": "4693925f-7e7e-4c90-8c47-b25d26ec8f4e",
"db_language_id": "70a80e30-0a52-47dc-8801-b130d765efe0",
"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-09-04T14:39:09.6467731+00:00"
},
"modified_dateutc": "2025-09-04T14:39:09.6467731+00:00"
},
"marketing_segment_id": "25d91410-14f6-4286-9075-df8224786fe5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d09b5efd-e70c-4196-9bc3-8db69a40ecc0",
"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": "377aee6d-c2f2-44c0-85ba-0b208507be45",
"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": "e0628cde-496e-4bf6-ada5-a6d82aea6658",
"db_country_code": "sample string 28",
"feelist_id": "046c5187-c777-4518-b74e-732067aa61df",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b71859a7-08ad-4400-b1b7-b78bd6314407",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dea13706-a594-4e5c-b45f-00dc44783d8b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-04T14:39:09.6467731+00:00",
"db_currency_id": "074278c4-0648-41e8-a35a-011e9eb35275",
"db_currency_code": "sample string 10"
},
"company_type_id": "f4119107-9d73-4552-9de4-fdb2df83a1c5",
"company_type_name": "sample string 32",
"company_type": {
"id": "4a091f3c-4eec-4e98-8eb6-9f4fd4ff5002",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9f1a60b9-c831-4f87-a3ed-4bb81fa50253",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0d3784b7-bed1-4cbd-a4b7-914fc1c0daf8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3b56d81e-2fb5-4e10-81c0-8c29a8d482ae",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "524ee929-d1d6-4acb-8a1b-c732321602e0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "309b49b9-c1f9-4223-81d5-3e4e749a9dd0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-04T14:39:09.6467731+00:00"
},
"company_sector_id": "eabde4dd-eeeb-4479-ad9d-64c1ce29aa3c",
"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": "a141f564-64b1-4459-81e8-5b9447d0e6be",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d2f10b4b-3c93-4a88-927e-a000e7529232",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "956fa185-3714-46b3-ad2b-a9408cd243d0",
"account_manager_user_code": "sample string 56",
"company_status_id": "ca3c9fb7-0d4c-4db2-8cba-65ed3e08b407",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-04T14:39:09.6467731+00:00",
"id2": 60
},
"db_language_id": "1ce63d87-9db8-46d9-908c-ddcea800f64a",
"db_language_code": "sample string 7",
"db_title_id": "dce3bbe2-2137-467f-9f37-65a1f2102975",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-04T14:39:09.6467731+00:00",
"create_date": "2025-09-04T14:39:09.6467731+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-09-04T14:39:09.6467731+00:00"
}