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": "17e0dcd6-0262-4b5e-81d8-719921fdc8ae",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d2a96aae-384b-4305-9e77-8b56fc0a81b3",
"company_code": "sample string 5",
"company": {
"id": "e489e9db-2439-4cc1-a9fe-bed9a55b0cf8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-23T10:32:29.5915326+00:00",
"sales_territory_id": "072cb6c2-4274-456a-a83e-9380cec398d5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "aee57e61-531d-4401-b751-04375da54ec6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "31411e6b-f268-4ed3-8877-35b984a30c02",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d3b60145-8364-4127-b673-0454e8dfc5b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a9605978-1921-472c-a660-26decdbb1a4e",
"db_currency_id": "e03ca122-9073-4e39-90eb-222f49961082",
"db_language_id": "a7dcb2fd-f6ec-492e-b21f-bbcad76ed535",
"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-05-23T10:32:29.5915326+00:00"
},
"modified_dateutc": "2026-05-23T10:32:29.5915326+00:00"
},
"marketing_segment_id": "1c8335bb-33ee-46eb-a81b-fd7a39cb6396",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6e017314-4537-4c2c-a805-b5b7bc246f56",
"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": "f5ed9dd1-a7ca-465b-b19d-894e81486a78",
"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": "14890abb-f27e-463d-9540-2eba15db5392",
"db_country_code": "sample string 28",
"feelist_id": "c5474ffc-7073-42e9-92f0-f67b95612601",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6062f4f6-b996-41e8-ab69-c4da0a2b2f5a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d7fe0f0f-fc51-40b8-9005-d54dea432249",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-23T10:32:29.5915326+00:00",
"db_currency_id": "39033934-cde8-4190-9311-370fa2930e4f",
"db_currency_code": "sample string 10"
},
"company_type_id": "58bae878-840b-4b34-81f8-78ab6698359f",
"company_type_name": "sample string 32",
"company_type": {
"id": "776d149e-26d8-4eea-8938-0dab0a56f6c9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "680af668-97c4-417e-9f7a-84a0113f88cd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1394d70f-dbc2-4fbc-a80f-1f148cd0066e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c9aa8b5e-ee3a-4ecb-932e-df8bce4f0c3d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ffbdb588-1d01-45c3-80e8-6f5f39a58977",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8f91e985-3e44-4eab-ab32-908966d329ab",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-23T10:32:29.5915326+00:00"
},
"company_sector_id": "ed1931da-5cbe-4790-8b06-b5334688db03",
"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": "5e18a85f-d76f-4242-b238-1947026a5b9d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c458444d-acea-4417-abda-21085c4153a8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "21f579db-3254-4aef-a662-dc49b37adc9c",
"account_manager_user_code": "sample string 56",
"company_status_id": "c3be7e6d-115d-471d-9db2-43b149c52527",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-23T10:32:29.5915326+00:00",
"id2": 60
},
"db_language_id": "e4492d63-f9ca-4145-9933-ce018c5b2720",
"db_language_code": "sample string 7",
"db_title_id": "8134d66d-90cd-4381-8207-e8c0be09e630",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-23T10:32:29.5915326+00:00",
"create_date": "2026-05-23T10:32:29.5915326+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-05-23T10:32:29.5915326+00:00"
}