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": "c92a7d58-0f1e-4231-9f47-04bced57261d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "15e6759f-bed8-452e-a1cc-b0b41aba53bd",
"company_code": "sample string 5",
"company": {
"id": "74cae06b-9ed9-449e-ab76-cd99eb5490cc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-10T22:08:26.8429874+00:00",
"sales_territory_id": "5278ea89-6410-4dd2-9de7-3d17708336fb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "38ed32f4-c3c1-43c4-bcb7-5a7ff34c6488",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a1402811-9e9f-49fe-83e2-fa2d9f7ad7b0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1adda8f3-f951-414c-a8cf-7be8544f63f4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0488070-aa15-4c38-9be4-32688de6063b",
"db_currency_id": "4597db6d-2775-441a-a8e0-cab9ff537c9a",
"db_language_id": "b907742e-3fcc-461b-8c38-c313105b245a",
"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-01-10T22:08:26.8429874+00:00"
},
"modified_dateutc": "2026-01-10T22:08:26.8429874+00:00"
},
"marketing_segment_id": "38988855-a414-46ca-b2d0-c7e5b7e1befe",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "98ea2ff9-7f4f-4d02-a450-47cec3d176e2",
"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": "352e87b2-b60a-44e0-b072-3b5beed8c34c",
"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": "203b27b8-d215-4de8-95ff-a914016138be",
"db_country_code": "sample string 28",
"feelist_id": "aa6c616f-3682-4e31-9f30-ce65214464ec",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4997002b-d152-4939-8006-bfe3e91115e0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "93373bce-140c-40bd-9c96-7db27256c220",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-10T22:08:26.8429874+00:00",
"db_currency_id": "e7405802-534c-49b7-bf4d-cb016ba0247f",
"db_currency_code": "sample string 10"
},
"company_type_id": "16688bf6-9f05-4501-9e1c-845622e48f04",
"company_type_name": "sample string 32",
"company_type": {
"id": "cbd255ea-b088-4048-b3d3-92105f5a936c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5be65358-2030-4573-a705-6a610003c4ac",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8c4972a2-c13c-4d76-bb7f-7b9b576bf5e3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0eecf10e-6f6a-4fca-90b7-e028153ce1ab",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fa16f2fb-2835-464e-b815-1b3e5ec0af6b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5ea34c41-490c-4b8b-ad20-d6a3e9b345b9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-10T22:08:26.8429874+00:00"
},
"company_sector_id": "c66f8a40-691e-40f4-9362-328d9d08b18a",
"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": "0ff983dd-ce8d-4a64-8a83-608a496ce957",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9fe5f12b-7db6-450e-9624-39cf04d33272",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "66861db8-9490-4e87-80a3-1b80b9a70802",
"account_manager_user_code": "sample string 56",
"company_status_id": "0d91eec6-fb15-4f4c-b62c-d122827dbd90",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-10T22:08:26.8429874+00:00",
"id2": 60
},
"db_language_id": "2eeb8fb6-1d0a-4089-8565-bd6fb4cd6593",
"db_language_code": "sample string 7",
"db_title_id": "bc30a9ec-b65b-4814-8963-21be1223734d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-10T22:08:26.8429874+00:00",
"create_date": "2026-01-10T22:08:26.8429874+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-01-10T22:08:26.8429874+00:00"
}