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": "2174a02b-d04c-4e5f-8787-9778474728c5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7883fa83-f7e1-429b-a7ac-9928e8516908",
"company_code": "sample string 5",
"company": {
"id": "82008b39-13cb-4b42-9e3d-931f6213f490",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-25T21:10:37.1910572+00:00",
"sales_territory_id": "45740628-6f49-4429-9c8e-82c2e902461f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f117e62a-eb87-48da-bbb5-65ea2e994728",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dd91b3f0-c862-4174-a83d-36d54dfb6dee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "126a2025-13c7-41fc-b8fa-5af6b82c3be9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a99f97d2-a714-456c-a909-1cae93b9b9ba",
"db_currency_id": "0df21494-5ada-46de-a46c-5d50e2d4c035",
"db_language_id": "1907b809-1f6b-4a48-b377-d2a50394c04e",
"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-06-25T21:10:37.1910572+00:00"
},
"modified_dateutc": "2026-06-25T21:10:37.1910572+00:00"
},
"marketing_segment_id": "a28f2735-00d1-4aa1-9b74-65e6804c74b8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "708e1c50-da9f-4984-b32a-0029fab16d88",
"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": "0ace4e89-7fae-4a03-a533-f8d1ad6601e4",
"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": "3c518f10-71f0-4b32-a3a9-9f91d8a8cf75",
"db_country_code": "sample string 28",
"feelist_id": "b3c39594-a60c-4918-92a9-a18f6fbac3bc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c30f61e8-1fd8-4994-968f-781b6b2435ce",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "925712a1-a7bb-4ffa-970d-5e8a26e4491d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-25T21:10:37.1910572+00:00",
"db_currency_id": "14f5de59-cb44-4cf0-bfba-2c9cdd089e2a",
"db_currency_code": "sample string 10"
},
"company_type_id": "27e3c667-8147-4292-9612-6a6024664d1a",
"company_type_name": "sample string 32",
"company_type": {
"id": "0c45139c-517b-43da-91de-2ff14cf124d9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9fc814ac-78b3-4411-8114-3acf50617fd1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "83128c63-be60-41c8-a1da-9f70622ac0d3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "106f78ac-885a-4b29-8903-a4cc6e10caa9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "89838637-f4dc-4638-b2e8-da96340067b7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c604d62c-76bf-48a3-b06f-10955ed54bd3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-25T21:10:37.1910572+00:00"
},
"company_sector_id": "b301c41b-1f5b-4e97-a738-0d591e09bab0",
"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": "f17d8266-8b32-46f4-96f2-22493230b9a4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1eebe7b9-2135-42c0-a3fa-f45be940ddc8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "14088414-6804-4623-b55d-91bc74aeaeb2",
"account_manager_user_code": "sample string 56",
"company_status_id": "c48d6c11-f579-4fba-899a-5c22011f481d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-25T21:10:37.1910572+00:00",
"id2": 60
},
"db_language_id": "57fc75c1-61ed-4947-8233-7d683db8c298",
"db_language_code": "sample string 7",
"db_title_id": "530e7774-b8fa-4c49-873c-4f03373ffb2b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-25T21:10:37.1910572+00:00",
"create_date": "2026-06-25T21:10:37.1910572+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-06-25T21:10:37.1910572+00:00"
}