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": "58bda997-2165-4cb0-bb9a-bf5d8ffe004b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "21de1576-264b-4ee5-bcbc-373757230b04",
"company_code": "sample string 5",
"company": {
"id": "924d13df-4aa2-4c7d-be15-85207f6373d3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-18T19:18:57.596914+00:00",
"sales_territory_id": "0d8e971d-739f-4b97-ac44-f8b924d64295",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ab0c1a76-b259-4eed-81b3-c01578d7db03",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bd0de76e-f245-4012-8900-ded65593689a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "201f6584-f427-4f3e-9ae6-c6a03896e372",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb198505-d27c-4227-9bb1-8d3891efcb07",
"db_currency_id": "0867918f-9ab9-4bd2-b3b8-eb866b217964",
"db_language_id": "3122f174-dd56-4689-8864-0046f9475fbe",
"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-18T19:18:57.6125471+00:00"
},
"modified_dateutc": "2026-04-18T19:18:57.6125471+00:00"
},
"marketing_segment_id": "f912cac1-8c14-4e04-a6d4-e72512bfba67",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8ab7bfb9-4697-4d1e-9162-4c5603eb3919",
"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": "b952cb35-a13e-4b63-8ece-28b127dfae07",
"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": "aeb3e84b-04f7-41a1-8336-5dd77dec7f9e",
"db_country_code": "sample string 28",
"feelist_id": "2027b2e2-08dc-4757-b93b-fb2b1c1d5392",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b9f334d4-c68e-452b-9ffe-23f1645a159a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0ef21955-634e-4d2b-94ee-2aedd439564a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-18T19:18:57.6125471+00:00",
"db_currency_id": "8d826c49-a4cc-48b8-aa60-165e80cacdc1",
"db_currency_code": "sample string 10"
},
"company_type_id": "59f12761-cb70-4e30-86e5-9db9d7ee3be1",
"company_type_name": "sample string 32",
"company_type": {
"id": "ec08a892-0b3b-4ea2-b4e7-a8f678e8c1e9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "41166db9-a1d4-43e6-be21-a1102a96339c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d8fc6e3b-879a-40b6-8d1b-b21c6f4c4aa7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f7ed6d99-5331-45f4-a253-c46dc588634f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "565bfcbe-85b2-4818-b503-9ba01050de41",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4b05c5e9-40c1-42f3-912f-341496045b18",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-18T19:18:57.6125471+00:00"
},
"company_sector_id": "158619b7-fa8e-4e60-bde8-32b9034c7f50",
"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": "299771ec-e144-4d44-980e-357221792e65",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4039ca5e-68b0-47c6-94c4-6707088a28b5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "99192e36-6548-45d3-9436-78a65b13c441",
"account_manager_user_code": "sample string 56",
"company_status_id": "86e4089d-8d92-4ad9-83db-978e494a69bc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-18T19:18:57.6125471+00:00",
"id2": 60
},
"db_language_id": "03e82f6f-95db-4fcd-81c5-bbfa58275cee",
"db_language_code": "sample string 7",
"db_title_id": "4c4363e7-fa2f-416e-8573-019cf595ec96",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-18T19:18:57.6125471+00:00",
"create_date": "2026-04-18T19:18:57.6125471+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-18T19:18:57.6125471+00:00"
}