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": "ecc7a934-b467-475b-a8bc-b69449091c22",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "55b475f0-9b8b-4f49-9fba-7b976aa1de55",
"company_code": "sample string 5",
"company": {
"id": "daf70062-8268-47a1-9f71-39cc0300182c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-15T23:23:12.8544313+00:00",
"sales_territory_id": "830366e1-fcd9-46f3-9266-13113482684d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "150244af-a162-432d-848d-f4826292e7a0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d2b1536c-b3c8-4ce4-8845-23bdf559b02c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "89d954d5-5d3e-4d96-921d-bcf9c9ddc0f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e05a81f-8337-4c31-bedc-45c1a93c6b39",
"db_currency_id": "ad9bca98-3d88-4f33-8998-a20e5c364ff9",
"db_language_id": "94237b5d-275d-49dc-aa85-fcbe214b1a63",
"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-05-15T23:23:12.8544313+00:00"
},
"modified_dateutc": "2026-05-15T23:23:12.8544313+00:00"
},
"marketing_segment_id": "d9edabaa-e7d6-4b60-9315-1b964ecbc8cb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "24c53144-e5d7-424b-bf2a-4911ed092d66",
"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": "690456fd-fd9f-4616-a031-67df906b222b",
"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": "2623929d-c118-4a44-a5fd-f75054bfb912",
"db_country_code": "sample string 28",
"feelist_id": "755de3bc-192a-4f74-ad20-de52ab8348d7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b85393a1-8a50-448b-8042-dd2a990430d4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1735b634-96ff-4808-a5df-35b98f6327a0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-15T23:23:12.8544313+00:00",
"db_currency_id": "037e55cf-7dab-42f0-8f0a-f12b9f499f66",
"db_currency_code": "sample string 10"
},
"company_type_id": "6e8da581-d4ce-4c19-99e1-04f2378da608",
"company_type_name": "sample string 32",
"company_type": {
"id": "73bb6a39-d59c-442c-afc7-87afd94a00ca",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8e16109b-da8a-4273-959d-52762b5df194",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8e744b48-918b-4cdb-8824-1acf3ed3d705",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "02b3a561-9f8f-42e6-a33b-b28e25fbe023",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c2f91843-4d2f-4397-9b86-e148cd67ed14",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2d79ab7e-adf5-4284-ad43-9f04bc460995",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-15T23:23:12.8544313+00:00"
},
"company_sector_id": "a8b333b3-a1bd-4295-8ddf-64b72eb1154a",
"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": "01f5a88d-4333-4a24-aa0e-c6d4f72831f5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "859c7f5e-6d73-4cc0-b018-d95b2cc3c249",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a4bdce2f-6548-4857-b906-10feb79a707a",
"account_manager_user_code": "sample string 56",
"company_status_id": "0d60272b-4664-4ad9-8a7b-c64df5d1c06f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-15T23:23:12.8544313+00:00",
"id2": 60
},
"db_language_id": "2323ad79-a7af-4f8c-ba6d-2633aed09d73",
"db_language_code": "sample string 7",
"db_title_id": "3f8e3da1-8910-4713-ab7c-cbbe908090de",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-15T23:23:12.8544313+00:00",
"create_date": "2026-05-15T23:23:12.8544313+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-05-15T23:23:12.8544313+00:00"
}