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": "f6f4d5f6-9638-4c28-afac-08133117cd93",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7f9dfefc-cdcc-4bae-8389-dfa1704c76e3",
"company_code": "sample string 5",
"company": {
"id": "05231dc6-1935-46d0-9b41-2dcffdce12b1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-05T08:24:08.9503926+00:00",
"sales_territory_id": "e623c50b-e95a-480c-9e3c-7fe6268833a0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "097ae0bc-ee65-4796-8d27-076bd8adcf0d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "647b2a1c-ed70-440b-b411-18b8f6a47563",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0202bee0-b5a9-4ec7-b736-2e61017a3031",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1dc20da1-e60a-4eff-933a-c95d64a06c40",
"db_currency_id": "1b2a7010-0d20-4b76-b170-5aa725b837cc",
"db_language_id": "b3f59e36-fe79-4947-875f-b9c3c9555d9c",
"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-01-05T08:24:08.9503926+00:00"
},
"modified_dateutc": "2026-01-05T08:24:08.9503926+00:00"
},
"marketing_segment_id": "8f44602e-da49-496c-b0a8-2defb6d3609c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0fa709d7-3e68-4ca0-9352-fe64b06db412",
"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": "b0911d8c-4621-4831-a926-09d75bfa55a9",
"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": "edafbba9-4cc3-4090-b37d-176ca1aa13b3",
"db_country_code": "sample string 28",
"feelist_id": "e4f2a2f2-3a84-456a-a497-0b6bc86c27a7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "abb1baa1-8801-4a80-9ab3-8ea3fdbc377a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2a33593e-1608-43f4-8736-a56b651e836a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-05T08:24:08.9503926+00:00",
"db_currency_id": "b214e8a2-12e0-4add-ab6d-8bc436d807e2",
"db_currency_code": "sample string 10"
},
"company_type_id": "ceddcfc2-33ea-4485-9819-5de54b498da8",
"company_type_name": "sample string 32",
"company_type": {
"id": "3025a31d-5b7e-4eb6-a3ea-90fae082562d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b5300ce5-c899-432c-9fe6-d96cfc7b40c7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "01ba7846-92a3-44df-ab6d-578386eff355",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f8a2e976-919e-4e3e-ab8d-ab22a36fac6e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bca589b6-67d7-4398-821a-8897da913174",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f020e900-3def-4588-86f2-7ebd04721a76",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-05T08:24:08.9503926+00:00"
},
"company_sector_id": "2f7ff68c-dcca-49aa-8363-d0d7fece367a",
"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": "4d4242e4-4cfc-4cc7-a85e-9ee611c8d540",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a5611cd3-5ada-4f21-9a07-07689f812f5d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e973618c-6551-481f-908d-895527622182",
"account_manager_user_code": "sample string 56",
"company_status_id": "24a3cc3b-f55e-4955-bcda-e17b9e01db36",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-05T08:24:08.9503926+00:00",
"id2": 60
},
"db_language_id": "a5bf24ac-170a-4026-be75-1793447d8fbf",
"db_language_code": "sample string 7",
"db_title_id": "108cb53c-8b0c-4d15-a38e-eecb224eea35",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-05T08:24:08.9503926+00:00",
"create_date": "2026-01-05T08:24:08.9503926+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-01-05T08:24:08.9503926+00:00"
}