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": "d0be9a69-2afb-4913-9b98-ac6af87bd9bb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8c04e383-dcb0-4f34-9f7f-e78d29c6b5ad",
"company_code": "sample string 5",
"company": {
"id": "59ad5f21-6470-4767-95a3-22d3ea2c368e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-14T07:35:19.9860107+00:00",
"sales_territory_id": "81c4485d-75cb-4fab-9d4f-cf08f90c7b3c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bb58c55d-583a-4332-b602-50638e2bde35",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e0918c42-3e10-4ba0-b33b-4c2d647d56de",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "57d32f79-3781-456e-b06b-75c8b91b98d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d297bafe-dbb5-4e51-bcfa-242ba7105820",
"db_currency_id": "dfd1091d-55d9-4eb3-8281-bfc485110520",
"db_language_id": "a4a75df4-c19b-4df9-a393-7c8c0e93b584",
"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-08-14T07:35:19.9860107+00:00"
},
"modified_dateutc": "2026-08-14T07:35:19.9860107+00:00"
},
"marketing_segment_id": "b79d286a-1b84-4328-8aff-f7b7293b046f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1925c82f-9b70-4642-9944-7342a9d13eb2",
"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": "7256c814-d80f-48c6-bdb1-ac91aca52259",
"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": "3622fcc8-b743-46bd-8f84-dbd27ed44f6b",
"db_country_code": "sample string 28",
"feelist_id": "923a0a95-a68b-46aa-a50c-ace3464aa874",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a9beec53-a8ed-49f1-af0c-8d1f4dc34d30",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8cb4aa91-1e8b-4cd0-9504-9d53a8b9b459",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-14T07:35:19.9860107+00:00",
"db_currency_id": "711e3f89-e2fa-473f-99df-704653ed72c4",
"db_currency_code": "sample string 10"
},
"company_type_id": "533500d2-a90f-438c-ae29-4ceacf691420",
"company_type_name": "sample string 32",
"company_type": {
"id": "db636f4d-787c-418c-8f6e-f8cc64e4dfc2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bb19365a-54c7-4aa0-b425-5acf4f2400e5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "777dc166-04c2-418b-b467-f8c7cce199df",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "72957f87-80dd-41fa-aef9-fa2d7d1207a4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "953bb584-a3d0-4bbe-8a0e-096ef7737327",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f34163fd-3e62-4411-9530-46d80c706f25",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-14T07:35:19.9860107+00:00"
},
"company_sector_id": "9d4bdd8c-a8f4-48b4-b0db-70d48ea72cd9",
"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": "7abbd782-d8a2-43cd-b6ff-7f7d7dcac479",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a2e5350f-fedf-4ecc-99dc-1fd713ee21a9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ce61898e-2e45-44d7-8f18-f518b092f77c",
"account_manager_user_code": "sample string 56",
"company_status_id": "8ba167bf-c0fa-4a1b-8b5e-0822047f2480",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-14T07:35:19.9860107+00:00",
"id2": 60
},
"db_language_id": "769ae454-9fa1-43b4-b077-3d40dae94cd8",
"db_language_code": "sample string 7",
"db_title_id": "972c2f1d-adea-46ac-b2d4-6a4ae9b45004",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-14T07:35:19.9860107+00:00",
"create_date": "2026-08-14T07:35:19.9860107+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-08-14T07:35:19.9860107+00:00"
}