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": "67b8c64c-f688-40fe-b6ac-7e79cb1f428b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7622d6c2-d969-4638-9bcc-797ec71e68c9",
"company_code": "sample string 5",
"company": {
"id": "a3800532-bd5f-4782-a344-6bfbfa217004",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-23T23:21:48.7133613+00:00",
"sales_territory_id": "89e0f2ba-a757-4d2c-b6d7-e5f8b5a40198",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a2c4b0da-75c2-44cc-b053-39978243d506",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5bed77fe-e87e-406b-9db7-03d46a8cbbc2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "062f588e-3a73-4c45-a133-05131d2e08f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aace3745-ea4f-4e39-b316-9db959a11109",
"db_currency_id": "67c3d462-32d5-482d-843d-b6bc9da2a4e6",
"db_language_id": "acc4af98-00e7-4075-a086-5b8b23e70ac0",
"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-12-23T23:21:48.7133613+00:00"
},
"modified_dateutc": "2025-12-23T23:21:48.7133613+00:00"
},
"marketing_segment_id": "2b239fcf-71c5-409f-85f7-dbee99103897",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "458a6651-d8b6-48ef-90a2-10df453cf982",
"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": "2d13c09d-9321-4fd3-9ee1-932fb247ce82",
"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": "55d622d8-af2c-4cb5-a506-2b60b6a7398b",
"db_country_code": "sample string 28",
"feelist_id": "2f992adc-9fea-4161-8344-0dd37628fd13",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1d47526c-211b-4bf3-832d-783bcc4980df",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3ce409db-1e69-4be0-990d-a4a9fb88f77e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-23T23:21:48.7133613+00:00",
"db_currency_id": "2695083c-2ef3-47d4-8498-c5d461ae8c65",
"db_currency_code": "sample string 10"
},
"company_type_id": "e3c8f0e5-c4e4-4ec9-b98b-4f2a3112e298",
"company_type_name": "sample string 32",
"company_type": {
"id": "a8b908f0-eb67-4276-9811-1d7c07a84028",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bdcad99a-4972-4644-889b-bfef8b20efd0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0dba0cbe-82bd-4cea-9531-97c0117dcbea",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4bcc0012-1cef-4ddc-bdd2-2b53c7052a4e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ff138453-7a71-44eb-9c6c-a35a8aa2a38e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b2f0d7c7-ba41-43f7-b7e6-8a04cc7b47bc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-23T23:21:48.7133613+00:00"
},
"company_sector_id": "629f84e3-0483-4431-bf31-33448b2617d5",
"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": "e2e206d1-7a65-4fd4-86aa-039db3d44fbd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2bcb6adb-257e-4d77-b8cf-147f58ef92bb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a0e63412-3c2b-420d-afec-2ac6cdc34331",
"account_manager_user_code": "sample string 56",
"company_status_id": "0f2b5221-a362-44be-83c0-98f978cfcd44",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-23T23:21:48.7133613+00:00",
"id2": 60
},
"db_language_id": "41f9a045-b61c-44b1-a6c3-4d4e7f9318ea",
"db_language_code": "sample string 7",
"db_title_id": "d25a1a28-5af6-4fa4-a237-2d6591755761",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-23T23:21:48.7133613+00:00",
"create_date": "2025-12-23T23:21:48.7133613+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-12-23T23:21:48.7133613+00:00"
}