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": "ff0860ab-b1ff-4346-b043-1ccb8fcb2199",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "392756b4-2110-4e49-aa66-e239873ef64b",
"company_code": "sample string 5",
"company": {
"id": "3321ace4-b17a-4a79-b693-0cc8bf0c3f3a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-20T11:35:55.5834785+00:00",
"sales_territory_id": "d7418594-b733-4da6-a1b4-48b3560c4f66",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ae0d1db2-cd27-4d67-86cb-2774e5e8ebbc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f3d72195-4450-461b-aa16-66618291bc5b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "538f5cec-2f76-4848-bfb7-f985b2bf3dc8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "75ee4293-93b5-47ca-85b1-262d1a0a86d2",
"db_currency_id": "c983ce5d-1bec-42e3-bf2f-6928a29e7993",
"db_language_id": "76b32597-ca56-4dcc-981d-1e45450d5133",
"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-06-20T11:35:55.5834785+00:00"
},
"modified_dateutc": "2026-06-20T11:35:55.5834785+00:00"
},
"marketing_segment_id": "d8b948d8-2b44-4bfe-9d7d-bb1eece7353a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a635e246-e517-4004-a3bd-163fde79385f",
"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": "56e92ab9-212a-4b31-b7ba-5b95afb59aaa",
"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": "72efc89d-3a64-473a-9052-562b5c463b06",
"db_country_code": "sample string 28",
"feelist_id": "f9d6bd1a-113f-43fc-9b9c-d9754c9ae0ec",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7c26dd9b-8e1e-4843-b9ff-9d786bdf33ef",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dba45968-090f-4181-9cf9-9ed0be9ac0e3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-20T11:35:55.5834785+00:00",
"db_currency_id": "7f18930a-ad76-4cd7-ba09-e8ba10bb937a",
"db_currency_code": "sample string 10"
},
"company_type_id": "6a30bedf-aad6-40d9-8e64-47e9d20ebd0c",
"company_type_name": "sample string 32",
"company_type": {
"id": "4bff936a-5c15-46fa-baaf-57ef6522bdea",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "15e8eac0-ff9c-4acb-bb1c-5e0f2f0e1dc4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "daf4bd8d-672a-47e0-860d-f126e7d4b441",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e4356b7f-6cc0-451c-9a19-25e59f15fdb5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "affc93ab-7f0b-44b9-9fa0-4611a828c13c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ea4b3901-860d-4d75-a205-2b7cc1f98c31",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-20T11:35:55.5834785+00:00"
},
"company_sector_id": "52b5b1ef-233d-4f0f-bda4-2b4376fc4a25",
"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": "dd669038-c0de-403e-bc0a-7a56a12c5035",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "139956aa-efd3-4e62-b3db-608dd617f878",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "25bf23e5-5ea9-42ea-9c17-1ae78e01d51d",
"account_manager_user_code": "sample string 56",
"company_status_id": "b3ecca70-a235-4d6b-b5c6-c1bb86ffc1dc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-20T11:35:55.5834785+00:00",
"id2": 60
},
"db_language_id": "14b43bf6-6857-4aa8-a18d-1816888fcd74",
"db_language_code": "sample string 7",
"db_title_id": "dd0a5e7b-7027-4703-b485-927b50867469",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-20T11:35:55.5834785+00:00",
"create_date": "2026-06-20T11:35:55.5834785+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-06-20T11:35:55.5834785+00:00"
}