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": "537fef38-4e76-4415-8a3c-7129302dc521",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fc7e312d-fc45-4208-9577-7e26e76460e9",
"company_code": "sample string 5",
"company": {
"id": "186d86c8-7b9f-475f-9fc6-dcdd50e775de",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-07T20:57:14.4197941+00:00",
"sales_territory_id": "b810195b-31cc-4f15-b0e8-130506206458",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6bcfeca9-7a73-4a93-b5f0-ea5ccef5f481",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "24f38310-f6ca-4dd5-a049-aad47c897667",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7ad91d13-bdea-4b68-adc4-19abbe916d9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66bc00d4-850d-41e7-9cd0-0d57838f06c6",
"db_currency_id": "03cb9f11-6fe9-4e60-8059-00a5bf6c045a",
"db_language_id": "b40779ee-ea40-4d01-8027-c2c899eda2de",
"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": "2025-11-07T20:57:14.4197941+00:00"
},
"modified_dateutc": "2025-11-07T20:57:14.4197941+00:00"
},
"marketing_segment_id": "88003d8e-7e2f-4b97-90fb-8bcea87fbe42",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4be3c520-491e-4bdb-a49b-9261e8bf28da",
"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": "3fa3dad7-b87a-4856-b206-3e60bfa37d6a",
"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": "4b8c0e71-0077-4b04-bdf4-2dda0e986afa",
"db_country_code": "sample string 28",
"feelist_id": "255e0f33-977a-4424-8b44-8b5f21916b0f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f1e2edff-0916-4680-964c-89da477d68f6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b62dbc62-2bd3-428e-90eb-545a8304a2aa",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-07T20:57:14.4197941+00:00",
"db_currency_id": "08723fbc-c09e-458d-b9d9-f7211a1392db",
"db_currency_code": "sample string 10"
},
"company_type_id": "39f47342-6c4f-441e-8f54-3343441f7e7d",
"company_type_name": "sample string 32",
"company_type": {
"id": "2226e6fe-14b7-4894-bca3-c6428dfe487f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c592f8a3-647c-447d-8be8-42e2d05d8ff2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d59e8d69-ccfb-40d0-bfa1-f78e91dbbdaa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0240683d-7a86-4303-b162-6e372cb82952",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2f38af7e-3648-4d8b-9125-0064af0cf6ac",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e4e9d520-cf3b-42d1-b474-47188f91a7e4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-07T20:57:14.4197941+00:00"
},
"company_sector_id": "f0ed800f-153b-446a-bd22-f8ce8c2e657a",
"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": "d8d11256-039d-4c02-ad74-50c2fdb59129",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "420e079c-3657-4459-9092-bc3d92622b83",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "24684f6c-224a-4ed6-8eb1-6900c77bbf03",
"account_manager_user_code": "sample string 56",
"company_status_id": "16859817-28ba-40db-94d7-db979a391af2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-07T20:57:14.4197941+00:00",
"id2": 60
},
"db_language_id": "dd4ae738-337d-41a8-aa16-410d6d54a346",
"db_language_code": "sample string 7",
"db_title_id": "944eeeb2-7c2a-4f09-b935-ceac0c149069",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-07T20:57:14.4197941+00:00",
"create_date": "2025-11-07T20:57:14.4197941+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": "2025-11-07T20:57:14.4197941+00:00"
}