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": "b7a3c8af-b692-4219-92a1-68033e65ffdb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2bcb12f9-dbb1-4592-a47b-7ef41c6d4ee9",
"company_code": "sample string 5",
"company": {
"id": "6d238ee2-6d41-487a-a850-6298f6bc090d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-09T15:12:50.3503052+00:00",
"sales_territory_id": "2fd3a9a7-8d8b-4932-b76c-d1c8df3bdb6b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "65e3429a-1521-4498-b458-27df057c998d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f2935921-010f-47c3-b5c3-42ab8695757e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9d984b80-2fef-493b-86b8-4857c2c83e13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ac24d7a-f05a-40e3-a757-6d42e6a093a9",
"db_currency_id": "bfe7dd67-7920-41dd-a9e8-ab2195ddd252",
"db_language_id": "8acab750-b688-4938-82e1-3c3b64c93a7c",
"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-07-09T15:12:50.3503052+00:00"
},
"modified_dateutc": "2026-07-09T15:12:50.3503052+00:00"
},
"marketing_segment_id": "1622c9d8-1ba1-4c20-bd7e-732629aaa6e6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "59ae411e-fb45-417c-80d2-45325c8913af",
"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": "6682c2f6-6c4c-41b8-b1c9-a7f53ee26394",
"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": "86731093-dfa9-4841-bff1-9c6210086b1b",
"db_country_code": "sample string 28",
"feelist_id": "1bae3283-1790-4cd0-9e22-146fb5d155d9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "590f8753-c488-456a-8761-d111432c7fad",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "21d4b382-802f-47dd-bee7-525ba76bac42",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-09T15:12:50.3503052+00:00",
"db_currency_id": "61bb8ea0-dedf-4fa1-9b2a-e08bb98598bc",
"db_currency_code": "sample string 10"
},
"company_type_id": "7c24cd72-c3dd-4eae-be60-eb108c7e69b3",
"company_type_name": "sample string 32",
"company_type": {
"id": "0d1186b5-beaa-4e42-8ad8-e237fa0a57d1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "42564486-44cf-4b30-9209-aefe8973f192",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4ec28a7f-b6f7-400c-9e2e-3e92f895cc05",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5029c30e-ade8-4a36-a7b9-79f5132320a8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "641bb40e-967e-4b2f-af7c-e9ac7fbcf1d5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8af1796a-a649-4b7c-9689-d9c6c1328048",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-09T15:12:50.3503052+00:00"
},
"company_sector_id": "d080438f-6618-4a36-ab4b-445c207e4a17",
"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": "0ee7e1c0-e44d-4e0a-b370-ea6bf45233cc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0d6e6af4-55bc-4b40-87e2-a7c40880a127",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e66498ce-cc80-4042-807c-1e26e52b3e9f",
"account_manager_user_code": "sample string 56",
"company_status_id": "41e048aa-1c06-4c4f-ad4d-809c83371771",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-09T15:12:50.3503052+00:00",
"id2": 60
},
"db_language_id": "625678e9-aa3e-4331-99f3-1fce44fa4f6f",
"db_language_code": "sample string 7",
"db_title_id": "2ca1379e-3ddd-43f5-8886-80b386eb4a7c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-09T15:12:50.3503052+00:00",
"create_date": "2026-07-09T15:12:50.3503052+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-07-09T15:12:50.3503052+00:00"
}