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": "90fe6aa5-820e-4ef6-950a-1c1f8272b5b7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "16521d48-e359-41af-b69d-3e599f96c4f9",
"company_code": "sample string 5",
"company": {
"id": "7c173a85-b3cf-46a0-ad4b-7f260ab1eea3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-02T13:00:01.4277299+00:00",
"sales_territory_id": "f3c70ecf-6f09-48f0-823c-fab673aa97d7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "513608b8-0eac-4eee-91af-816e9f09ec7a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e9bd96d-12ea-4a8b-93f7-821dd7246496",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2eee2841-0443-4312-ab50-52493f0ce6a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baf4f54d-7ae4-466f-9e18-658eed21833c",
"db_currency_id": "a7a0735c-043c-4a6b-98a2-788532fbba41",
"db_language_id": "875b3d85-0ab6-4c28-b429-bf5da6d18b81",
"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-02-02T13:00:01.4277299+00:00"
},
"modified_dateutc": "2026-02-02T13:00:01.4277299+00:00"
},
"marketing_segment_id": "f2cbe86f-7ac5-4263-93c4-8440ee55a2af",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "38ebd2c5-4441-403b-a632-3a4c6c07e762",
"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": "4f8ff8b7-c644-44b0-8b7d-840df6e367a4",
"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": "1b5da4c5-de03-4808-9ed6-49901d582037",
"db_country_code": "sample string 28",
"feelist_id": "dd3602c9-bb00-4a75-ad63-067019712b95",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "24ca4f7f-e185-4c6e-a707-7e507b5bffb9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "69d26533-4dc5-41a8-bba8-0d2fce5b6905",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-02T13:00:01.4277299+00:00",
"db_currency_id": "c63f36ac-13e3-496b-a221-43b2264cc755",
"db_currency_code": "sample string 10"
},
"company_type_id": "cb4ebc91-b615-4776-a5e8-c4d6c1192423",
"company_type_name": "sample string 32",
"company_type": {
"id": "04c48bce-f67d-4e78-b544-91222db46068",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5e15766f-1027-4a68-a146-567b7b87597c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fa461c3f-b3d6-4cb3-8125-b93ce392e68a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "04277954-93cb-4319-a19f-1b6a9c8f88d5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e5b75ea0-7638-4055-ba39-06fe47e90a38",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2330e378-14d6-4710-aea1-2516f2c5b7e3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-02T13:00:01.4277299+00:00"
},
"company_sector_id": "86cc944e-d63d-4e60-8a22-f5eb5c3351fa",
"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": "b10246d7-98cc-422b-ac8f-3aa7e2ff8602",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8fad32d2-3906-40b8-bce4-fc10c999bb3c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "77ed44e2-c63b-405c-b139-12008eb4dc25",
"account_manager_user_code": "sample string 56",
"company_status_id": "0ecb892c-3d53-416f-a4a1-0fd65a720c95",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-02T13:00:01.4277299+00:00",
"id2": 60
},
"db_language_id": "e4489e5e-4e55-47a1-8c6a-1882329f26aa",
"db_language_code": "sample string 7",
"db_title_id": "abaf4420-f9e8-46cc-981d-d7630a22c4d0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-02T13:00:01.4277299+00:00",
"create_date": "2026-02-02T13:00:01.4277299+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-02-02T13:00:01.4277299+00:00"
}