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": "fdb18e66-849f-46aa-b7f4-5410f7c1e1f8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e526727e-5a75-413b-a3df-7feaec37660a",
"company_code": "sample string 5",
"company": {
"id": "ff9f28a1-80cb-4fb7-9554-7e14043926f1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-21T21:45:25.4589915+00:00",
"sales_territory_id": "4a75f6c5-499e-4e42-849c-2e334e584c36",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a4e2394a-ba01-497a-9447-8cef7381b5fe",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a824dca3-d231-4913-b6c9-8ada3949e6c9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fa187cc6-1931-4d23-9f27-4f54991b6c1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ae1994a0-6af3-489e-ab70-21977d47ac7c",
"db_currency_id": "e4bf4aa9-6b22-4204-9fe8-b6024003612c",
"db_language_id": "bf9d0ed9-2106-468e-a656-40e8057af573",
"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-08-21T21:45:25.4589915+00:00"
},
"modified_dateutc": "2026-08-21T21:45:25.4589915+00:00"
},
"marketing_segment_id": "31217266-27b4-41d5-ad69-a7f554278cee",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "00251614-218d-4369-ac57-7b17c4f0c05b",
"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": "d25c76c4-e07e-4f72-a317-c89cdfdb1f50",
"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": "eecbd570-d503-4a32-b7ae-d99a3ae5763d",
"db_country_code": "sample string 28",
"feelist_id": "a20b03f4-269c-4180-afe2-3ae385d79177",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f16bf7b5-26e1-4ec1-9c37-64fbc962fe22",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c6e3e992-ed4d-4cd2-84d8-501b5421cce8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-21T21:45:25.4589915+00:00",
"db_currency_id": "7db709ac-c5bf-4b26-bce3-1396340f65dd",
"db_currency_code": "sample string 10"
},
"company_type_id": "54b66c2e-cbfa-43bf-9bfa-73c5dec6898c",
"company_type_name": "sample string 32",
"company_type": {
"id": "fa106d88-76e8-4edf-ae11-c567af31caec",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8780cb18-9663-45be-93ad-748c6138807a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ba6407f5-31cb-4a7c-bb10-736e33aed996",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "32aef6b0-1a5f-46ba-a9fe-25fb144f4428",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4a4b8de4-b52a-40ea-9249-f49dfff1fc8b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bea68680-89ff-44fe-8102-b8f9f8908e97",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-21T21:45:25.4589915+00:00"
},
"company_sector_id": "0370b57f-d415-4a28-b055-9ddbe2a8ffdf",
"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": "8a45896d-8cbc-4790-8735-9c014fbe1cb2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bf434000-d314-441c-80e9-aa23b19b18b2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9a395aa7-6fae-47b2-9898-252b8ec3e2b7",
"account_manager_user_code": "sample string 56",
"company_status_id": "4483c200-391b-48d9-b8e4-fce68dd9c88b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-21T21:45:25.4589915+00:00",
"id2": 60
},
"db_language_id": "5e4d906c-83cb-487a-8859-f7acf433ce98",
"db_language_code": "sample string 7",
"db_title_id": "463a9047-0cc3-407d-83ab-6d3e4fe46502",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-21T21:45:25.4589915+00:00",
"create_date": "2026-08-21T21:45:25.4589915+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-08-21T21:45:25.4589915+00:00"
}