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": "ef9918c7-67d7-4c38-8954-97ac91434916",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "69971e81-1df9-42fb-873b-f0e241a0f1db",
"company_code": "sample string 5",
"company": {
"id": "e19800fa-41d8-4d7c-bdfd-f931f06c0cac",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-07T23:33:22.6547421+00:00",
"sales_territory_id": "8c4e8aac-5119-48d4-8bf7-53103422f4a0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c5c17c21-e170-4cc8-84b3-b653cc317470",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "91fcdce9-f4ce-4340-9aef-b7ee271bc17f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8c065c89-b9c4-41a6-99d9-e6d427113c10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6310e6fc-ae91-4d52-8f41-45b9f0c11400",
"db_currency_id": "f2d32380-4e75-4bd7-8beb-772c5ffbbeab",
"db_language_id": "0bb3dafa-78a4-456c-9102-c6f4b110fa1a",
"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-06-07T23:33:22.6547421+00:00"
},
"modified_dateutc": "2025-06-07T23:33:22.6547421+00:00"
},
"marketing_segment_id": "cd9c1679-71ae-4bd4-abfc-495cbf9b6106",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bb7a5dba-99f2-474c-92db-7c76243e225f",
"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": "f009e3ca-33ef-4ae8-bd4a-8f56e7f9d3c4",
"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": "f1a32402-91b5-4c38-aeec-1ac18fbd0fcd",
"db_country_code": "sample string 28",
"feelist_id": "8042fd12-fa0d-4f82-a23b-adb481246656",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "00147928-2a93-48d4-98cc-122795eb6fd5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fdac4c30-a70c-44b3-b955-9f0dc158fe94",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-07T23:33:22.6547421+00:00",
"db_currency_id": "90794e48-0072-404c-93d5-86d0b2adf405",
"db_currency_code": "sample string 10"
},
"company_type_id": "4d07adac-4051-4010-8e4d-3035df78f96c",
"company_type_name": "sample string 32",
"company_type": {
"id": "e9733ba1-81ba-4159-82e8-99e3973a123e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d264fd7b-bec0-4af5-9ff6-904e32c46152",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6c192ba1-b228-4aa9-947c-992df6f6958d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6f92b734-cfee-4d50-91d7-330b6ad520be",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7cda7a40-bbbc-4681-bb4a-e7b6a9a6ed3f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a58aaf22-5f42-428e-b1fb-75966cd8ef06",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-07T23:33:22.6547421+00:00"
},
"company_sector_id": "b27c1f26-4bc0-4330-97a6-e19b0f3e1091",
"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": "d96dc1c5-ce95-4730-b157-a72c918116f9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7c127357-7f78-4345-858a-e7c1744727de",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1953a670-ac28-4bfc-a615-e63ac590d2b5",
"account_manager_user_code": "sample string 56",
"company_status_id": "1755721b-8c0e-4b6d-b56c-d373337315c3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-07T23:33:22.6547421+00:00",
"id2": 60
},
"db_language_id": "1bd9c460-0700-4ec5-96db-187181dc9b4e",
"db_language_code": "sample string 7",
"db_title_id": "5effe3a5-5609-4723-8251-7f0d1f634833",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-07T23:33:22.6547421+00:00",
"create_date": "2025-06-07T23:33:22.6547421+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-06-07T23:33:22.6547421+00:00"
}