Retrieves the 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": "372b8433-c035-4d7a-8d85-b953695398ba",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "76402352-ce87-4458-a13e-be315e510d33",
"company_code": "sample string 5",
"company": {
"id": "7f3f555d-fb9f-4e21-a37e-cacf8a8b04a2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-11T05:18:07.5817904+00:00",
"sales_territory_id": "46dfa6b4-f9e4-48c7-8ffd-1789dbe0dcfa",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "994aed2f-2bf8-468f-9a94-b3274a3ae326",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c3abd24d-8eef-43ff-8467-5fb158f77e1d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cade5357-1a6a-4fc6-aed7-7d70d82b0daf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3dbd0575-fd06-4d44-88d9-88315330f746",
"db_currency_id": "349b9287-cb2d-4075-91a5-f3db451ed225",
"db_language_id": "adbc4664-59b1-42bc-bed1-5b79d4a251db",
"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-11T05:18:07.5817904+00:00"
},
"modified_dateutc": "2026-08-11T05:18:07.5817904+00:00"
},
"marketing_segment_id": "0e88a9b9-7d3d-454e-800b-541e6ec3e17f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "22e6b81f-ca0d-4828-b632-b0fe3db15435",
"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": "b3b0534b-3f12-4d0c-b5a0-24f72dd32168",
"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": "713bb1ce-db00-420e-9110-85330d075f37",
"db_country_code": "sample string 28",
"feelist_id": "4f33ef33-7932-45c9-87fc-1ca19fa25216",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "26712c5b-c9eb-4d19-a697-24b8a91887d8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fcfb06d8-0d26-4a02-84c6-cfd2aeaeec98",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-11T05:18:07.5817904+00:00",
"db_currency_id": "e0f92d12-e256-46af-bdc2-9a43228654d0",
"db_currency_code": "sample string 10"
},
"company_type_id": "0ff21613-88f4-4436-b3c7-4adbb627ee88",
"company_type_name": "sample string 32",
"company_type": {
"id": "40ea0abe-1271-462d-9818-250c64a25c10",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "863eea93-8b09-47d3-966b-f1ceb7e2a788",
"sales_organization_code": "sample string 5"
},
"db_language_id": "09d9c671-61c7-4fd8-aefc-2d74b7a77cfb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2fa0275c-9a65-400e-8958-3995e7964097",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2e65465d-4720-45d3-905e-5cc1bd0aaeeb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bdbad374-10fa-4a65-99da-fc89a4bb6388",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-11T05:18:07.5817904+00:00"
},
"company_sector_id": "1e31b6f6-1275-4949-aac4-0cca7aed9452",
"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": "d79018f0-b35a-4d98-a994-80c206d6095c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5265a7b1-36c4-454f-8837-f4c3297cccb4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5a25cf4b-f7cb-4ca3-a120-e7bf5e021bcd",
"account_manager_user_code": "sample string 56",
"company_status_id": "01c14f29-53b5-400b-af3d-e13b4135a40c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-11T05:18:07.5817904+00:00",
"id2": 60
},
"db_language_id": "f798ef57-8a42-4aea-b804-4061464307ba",
"db_language_code": "sample string 7",
"db_title_id": "883071c5-7ac0-4f40-86dd-70fb060776cc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-11T05:18:07.5817904+00:00",
"create_date": "2026-08-11T05:18:07.5817904+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-11T05:18:07.5817904+00:00"
}