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": "27934d4b-fba5-4212-83d3-ab500440bbf7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "33f72424-1f6e-4133-b625-421f252d6a51",
"company_code": "sample string 5",
"company": {
"id": "da248589-3092-4c97-941e-b668f7baa34d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-18T11:20:36.7968816+00:00",
"sales_territory_id": "1f4236b5-15b3-4e41-9fdd-e4331ccdca8a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fd22a4c4-7af7-4cf0-94bf-4dbc0366ac11",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9486a661-bd4e-445f-86d4-3da4036ea295",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a65e7180-a2e3-4edb-b1ec-58877e41ba60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40937850-f74d-48d8-a57f-b9db46536a71",
"db_currency_id": "962752d8-5e1f-4a76-860e-40f19f57ca28",
"db_language_id": "b3d98dbc-9b38-4902-9c8a-e6d9423f7b7e",
"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-09-18T11:20:36.8125093+00:00"
},
"modified_dateutc": "2025-09-18T11:20:36.8125093+00:00"
},
"marketing_segment_id": "f03026dc-e77a-473d-b55f-5a5c300ddeba",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e6d703b2-17f8-43af-9c59-cc23de658b87",
"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": "be9e7de0-f541-4e8b-8ecb-674995fd7e47",
"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": "1b95b3a7-e455-40a1-b670-0fe10a3a2e4b",
"db_country_code": "sample string 28",
"feelist_id": "e3747026-479a-4651-a0cc-82ff9e810d6a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fb6b6d02-0374-4a83-a93a-ec255fd9a506",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f14d7401-e751-4aa1-88b0-150679373721",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-18T11:20:36.8125093+00:00",
"db_currency_id": "699334da-2860-40e7-8586-2f48a8590866",
"db_currency_code": "sample string 10"
},
"company_type_id": "f09381d7-fb4e-4ef0-93d7-48b278380c95",
"company_type_name": "sample string 32",
"company_type": {
"id": "a1ded6ed-1822-4dc0-a059-6a4780c63fb0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "09998f75-cfef-41bb-958b-52818211cd9f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3f1c287c-12f7-4144-a36e-4e32cd3c5dbe",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5cc6d192-0419-44d5-95da-66b3e6c13be1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b58b7e1d-3adb-4336-9ce6-446367af9a90",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4a35873f-d637-4142-a7f9-9f951bda2024",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-18T11:20:36.8125093+00:00"
},
"company_sector_id": "58b9721c-4c72-45a0-b80b-7f5da75b94fa",
"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": "fbb6f002-d4eb-4977-9dbc-6f4f005c8fa3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "253e7679-dd98-47b1-963e-306dd78928ac",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d647cc86-6626-4051-8b16-e38396d4268d",
"account_manager_user_code": "sample string 56",
"company_status_id": "1f6754c6-8ba9-4c92-b10b-693b39c4bfc5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-18T11:20:36.8125093+00:00",
"id2": 60
},
"db_language_id": "46ebbd87-7d2a-4fd3-8bed-7682fc824285",
"db_language_code": "sample string 7",
"db_title_id": "7c3d5d29-15bf-4447-9546-179497d5ae79",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-18T11:20:36.8125093+00:00",
"create_date": "2025-09-18T11:20:36.8125093+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-09-18T11:20:36.8125093+00:00"
}