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": "4f0a4f30-e284-40c6-bcd6-ed51abec3935",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7376c680-48d0-4712-b6bb-8822f20cc2a6",
"company_code": "sample string 5",
"company": {
"id": "91cceb88-0084-4503-acdf-115b20da4d41",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-03T11:01:40.7822748+00:00",
"sales_territory_id": "aca27293-2bc5-4789-8742-dda5fac5bf3d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bc0d202b-e6bd-43bb-ada9-c8e5f8cd2ec0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b56c9f88-438b-4a88-a49b-2f4a8b278b40",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c3f9e0df-4863-40f3-af31-ad7b350471a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff16930f-a3e0-4cd6-9af0-e6525c7df2ac",
"db_currency_id": "7762dc17-9fa9-4b71-8b67-f3877a0dc9bc",
"db_language_id": "5cc293fc-fa6c-4722-8b6f-2485d9755a80",
"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-04-03T11:01:40.7822748+00:00"
},
"modified_dateutc": "2026-04-03T11:01:40.7822748+00:00"
},
"marketing_segment_id": "94d49939-46e2-48df-a9e5-63c6261b8dd3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "70afb61d-6223-42d7-8988-baa008366926",
"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": "de413c87-e237-4a20-883b-8664e88b9323",
"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": "87be581f-5c2a-4b4a-a2ee-45f685cbca66",
"db_country_code": "sample string 28",
"feelist_id": "99f56656-62fc-4b56-a641-a730635dfe96",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "932c6387-358a-4780-a2c5-193c2f9f8aa1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "255a5244-b589-4e99-bfb7-112c20b485a7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-03T11:01:40.7822748+00:00",
"db_currency_id": "65c2ab52-2b7c-4b3d-8671-0b90403f1e68",
"db_currency_code": "sample string 10"
},
"company_type_id": "59332e71-a84b-414f-b831-1d3be0796e08",
"company_type_name": "sample string 32",
"company_type": {
"id": "663ef448-90b0-4bfe-aef4-1abddf943a17",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "92ca6304-50fb-44ce-85f3-6d2487cd7b05",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fc770db5-a8fe-4b19-884f-f745a947ca8f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8f4cea20-550f-4395-b522-034132661407",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6d36f6c2-88db-4a55-86c0-9b9d8239ed48",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e2fc0f1a-3987-47b0-982a-1afa90cca67d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-03T11:01:40.7822748+00:00"
},
"company_sector_id": "aa47e311-5cd5-4e4e-98d3-e2aa6ce35afa",
"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": "c52e1ee0-4afa-483c-8c42-e0ebc84592c4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bdd3ee28-8b51-40a4-adb2-9aaebff00b77",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "04a90376-0a0f-4b55-837e-8b42b84ec47d",
"account_manager_user_code": "sample string 56",
"company_status_id": "80d213b2-0f29-42f9-9458-963c16661417",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-03T11:01:40.7822748+00:00",
"id2": 60
},
"db_language_id": "c1751651-1774-4191-80e0-b08bd22758ee",
"db_language_code": "sample string 7",
"db_title_id": "ef7a4858-0110-4267-a8c0-3482f8f8c0c6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-03T11:01:40.7822748+00:00",
"create_date": "2026-04-03T11:01:40.7822748+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-04-03T11:01:40.7822748+00:00"
}