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": "ad6dd14e-6ca2-490a-a4fc-0bc50ba1f8ab",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c402c124-4915-431f-a235-e0cfd1bf04ef",
"company_code": "sample string 5",
"company": {
"id": "4184f9a6-b3b2-4bd2-8e78-f33250cac120",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-05T09:36:34.6978456+00:00",
"sales_territory_id": "804e0816-4163-4217-ac1a-986446a2ea89",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a1b9b0ca-0e0c-4167-90ce-63b279dbb2ad",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9bcbdd8b-2cbc-487d-a4ca-1460720229e4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5c065e98-be2a-424a-99f5-e5848b22c0e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afd4821b-d701-4c42-805c-6c3ebdc453c6",
"db_currency_id": "daad5f98-5ec6-4274-941f-c5a1d0336a3c",
"db_language_id": "8eea168d-666f-466f-9251-1764e8c4f13d",
"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-05T09:36:34.6978456+00:00"
},
"modified_dateutc": "2026-10-05T09:36:34.6978456+00:00"
},
"marketing_segment_id": "bd729b2c-20a1-414c-865f-7032aaeaaa9e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4b29b233-bc12-4481-952b-de9ffc292983",
"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": "844f3aeb-2736-4f0a-bf76-08e3183728a3",
"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": "871cb087-4193-480c-9e29-e98d63a6cbbd",
"db_country_code": "sample string 28",
"feelist_id": "306ce15c-6d2b-4795-b6f1-322469eaa989",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c07be288-9673-4111-a49e-6525c84a5f61",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a0c0ed8b-1f39-4d9c-866c-7ab341a5873e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-05T09:36:34.6978456+00:00",
"db_currency_id": "7ed7c257-fbf4-42ea-9a1b-52083e959eea",
"db_currency_code": "sample string 10"
},
"company_type_id": "5a0fa93b-783a-4257-a812-4b575d62601c",
"company_type_name": "sample string 32",
"company_type": {
"id": "45a617d1-9a5a-4270-96c4-3d43598f5128",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b21233d8-d843-47dd-9fdc-0d13db40d404",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1db949ac-eea0-4d8f-9362-090f4a93e270",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "61268c0f-1c43-427e-a80e-a7df14ac2813",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "85fc2aaf-05ac-48b2-a399-1e28b4d1a9a6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8d50299a-1088-486b-ae30-ac9f21a696e4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-05T09:36:34.6978456+00:00"
},
"company_sector_id": "dc7ab94b-249a-4285-aa27-6fa3e9ffe043",
"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": "4e2731f6-43ef-4cc7-9ca7-a5ed1ad85262",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "02478139-39db-4bb9-970d-a7a01ca03b6c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bd353435-1f06-4fc9-84ec-0222e9c29a0c",
"account_manager_user_code": "sample string 56",
"company_status_id": "da7d6948-a2e6-4f85-8e22-50abb4c8e76d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-05T09:36:34.6978456+00:00",
"id2": 60
},
"db_language_id": "0d473a58-3b46-4765-afbc-1581831b701e",
"db_language_code": "sample string 7",
"db_title_id": "bf560a11-ee00-4e7d-b61b-a2336ff53416",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-05T09:36:34.6978456+00:00",
"create_date": "2026-10-05T09:36:34.6978456+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-05T09:36:34.6978456+00:00"
}