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": "7df3a581-4975-4c58-9e55-8c7f1e9be868",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b4055e21-d73b-47f4-b8b1-c079a962af53",
"company_code": "sample string 5",
"company": {
"id": "60a16301-7265-4fa6-b6a7-5f3d6c936b04",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-20T02:28:08.8888928+00:00",
"sales_territory_id": "c81b09e9-7948-49c4-8e19-cdfca6ab07fb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f9560381-8c2d-497a-98c6-b514eb634bde",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8760ba76-c2b0-493a-9e24-2236060ab913",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b25988df-abea-45da-9f92-722b1d86d4b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "551dd8c0-164d-4ca2-82d5-8f7dfd8788d5",
"db_currency_id": "a286ab77-1c6d-4e66-bb6c-953cea255a4d",
"db_language_id": "7c2919a8-62ee-4dca-b4cd-bc6edee7c642",
"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-10-20T02:28:08.8888928+00:00"
},
"modified_dateutc": "2026-10-20T02:28:08.8888928+00:00"
},
"marketing_segment_id": "85d68251-e085-4c65-a854-a9991221e8f3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "22f433aa-fad3-42b8-9b72-bbad945918bc",
"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": "48317a74-a97c-4745-84b0-60ec5894d4ee",
"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": "fee33e7a-4739-46b5-887e-5e6c0613e8bc",
"db_country_code": "sample string 28",
"feelist_id": "cf3adc28-9f10-46d5-9c5d-6a3e809ab1ca",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "be7557ec-b9c9-4169-953e-dda0c415451f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a7c95386-d563-4140-9824-d9a644e0681b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-20T02:28:08.9069907+00:00",
"db_currency_id": "5a7ccdb7-e6b4-4e47-83d7-278c5712dd0b",
"db_currency_code": "sample string 10"
},
"company_type_id": "afb2b50a-f698-4098-ab91-adfe44fe1f30",
"company_type_name": "sample string 32",
"company_type": {
"id": "5a91a355-5cb9-4486-bd9d-0d721e6a4e26",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e85597a8-83ad-4e80-a796-5350921012e6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "da9e38af-b7d5-41d6-a59a-8acd68a59314",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ccdf4212-127b-4ae6-a974-c32bcf22d8f6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c10f2e13-4493-4088-bf0a-eab7a3a4b724",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "64092b68-7ada-4b35-b7e0-78f248bd3983",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-20T02:28:08.9069907+00:00"
},
"company_sector_id": "71171b42-3aa8-4c33-a453-e2352377c74d",
"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": "cb8067a8-c1f1-4f86-898c-619ae8f4718e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "44218b2e-f464-4a10-83db-d85c90d8114c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fdcd75cf-de5c-44c2-a7a6-c0800e47f6ee",
"account_manager_user_code": "sample string 56",
"company_status_id": "66c5fe79-04a6-4058-bbd8-69a31c0eb062",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-20T02:28:08.9069907+00:00",
"id2": 60
},
"db_language_id": "8ce2e918-da07-49d4-b113-749a81465404",
"db_language_code": "sample string 7",
"db_title_id": "c4bec19b-e135-4b7c-bee4-c2224b5a2835",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-20T02:28:08.9069907+00:00",
"create_date": "2026-10-20T02:28:08.9069907+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-10-20T02:28:08.9069907+00:00"
}