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": "39f5e81b-a908-485c-b747-9e95875e1a61",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "04e7c070-f966-4361-a39c-e5db2d2aa769",
"company_code": "sample string 5",
"company": {
"id": "dce7448e-9a00-4898-806a-6e961d056c58",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-06T17:32:29.3914943+00:00",
"sales_territory_id": "e7c42469-f6bc-486e-9223-7193e24a8c13",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8a3a18e9-f4a5-4f24-92a3-b2961122ba2a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0c699230-77ab-4559-ac7a-17a1aa375c38",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9b7940e2-d555-47c2-83e7-3983b5966ade",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "615f2b12-1b1e-4772-b528-eb3fe08cf6bb",
"db_currency_id": "8cbbda56-7cd6-4213-a5df-2c07a385fe61",
"db_language_id": "0bdfbe86-d922-4b32-9c92-024520bf88ad",
"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": "2025-11-06T17:32:29.3914943+00:00"
},
"modified_dateutc": "2025-11-06T17:32:29.3914943+00:00"
},
"marketing_segment_id": "ec809723-4d00-482f-bd60-14a25ac73eaa",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5f5a2a13-3d79-4c7a-9725-3cff947f9af1",
"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": "97d740df-645c-40ea-b2ec-4814135d7a69",
"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": "f37ebf24-5667-4389-ab1b-7dcc7377df5b",
"db_country_code": "sample string 28",
"feelist_id": "b9ebefa3-e0bc-497c-bb22-9acce96f2144",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1cc2b8ed-7e3f-48ac-b9d6-b4120ff6997f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a7b3f395-c786-4c98-a18c-a4d06f6e741c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-06T17:32:29.3914943+00:00",
"db_currency_id": "02502d6f-315a-4b64-97f8-61f090c90a20",
"db_currency_code": "sample string 10"
},
"company_type_id": "7c858450-2786-46cf-8229-b84d07a93b42",
"company_type_name": "sample string 32",
"company_type": {
"id": "19f59f54-fde2-409e-a72e-99535dd2b1b5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "492729aa-5ce6-43f3-a968-66160e29dd5c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "119cddd7-8ed7-4347-aaec-1031bcd982ce",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d8cb586b-9df5-43e4-ba9f-ef9d6f853ac0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d2e1a8fd-b08c-4fe9-b22d-ea19047f4fc9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "10337956-5b89-45ee-833d-41e2ee7568fc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-06T17:32:29.3914943+00:00"
},
"company_sector_id": "5831f3cb-fbeb-4f48-a83e-f6832ce6b93a",
"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": "719915b6-d095-4d88-8cc6-42ba38e5b71b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "106846ff-71eb-47b8-bd75-68d72aff0adc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4f712e2a-d376-4a26-9d50-bfa28ca3a6e3",
"account_manager_user_code": "sample string 56",
"company_status_id": "71750e33-5afc-4aa8-b9f9-eba9d5cdf2c1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-06T17:32:29.3914943+00:00",
"id2": 60
},
"db_language_id": "8e10d373-f6d3-4f5a-8271-bbe01e134ef8",
"db_language_code": "sample string 7",
"db_title_id": "f33b9ad1-5f28-4c5a-9790-202e76cf959c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-06T17:32:29.3914943+00:00",
"create_date": "2025-11-06T17:32:29.3914943+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": "2025-11-06T17:32:29.3914943+00:00"
}