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": "b8841e3b-f40b-4434-b371-7889f1e8c09f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a4b0733c-fcce-4a13-ad9a-774e4700acd2",
"company_code": "sample string 5",
"company": {
"id": "cc36ae24-f98a-4557-b965-f17b8bf9c0be",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-06T09:28:23.2523994+00:00",
"sales_territory_id": "95e19b4d-0021-4fa2-90c4-89c202c47713",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "172e0f92-61fc-4633-83c6-c3fe04d15f86",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dae4a5e6-5c83-4a64-a5d3-cfc9ec89dbc9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "599bef49-1526-46cb-822c-ef094af230fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "80e1a412-1f85-4b0d-9c76-f864a7529261",
"db_currency_id": "c6dd8c9b-982d-4b18-b2ea-f397f396f0e4",
"db_language_id": "dfb68706-178c-4ce0-940c-de30e24e90a3",
"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-11-06T09:28:23.26517+00:00"
},
"modified_dateutc": "2026-11-06T09:28:23.26517+00:00"
},
"marketing_segment_id": "00c00360-6f6a-4812-adfe-01d0ca833a05",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "50116aba-307a-4c4d-839a-a20329fa6dba",
"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": "d17953ec-7902-4f7a-8bfb-dcda71e55dcf",
"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": "c38619a1-5001-45f4-a479-57dcf43d9054",
"db_country_code": "sample string 28",
"feelist_id": "f0590f8a-1970-458e-9984-e70811dcad61",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f2e1c5cb-2fcd-41e2-ae33-1de62043090b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ed4851f0-bf59-4fbb-a1a6-f1f5a809663e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-06T09:28:23.26517+00:00",
"db_currency_id": "b2fd68e9-c503-495e-b24f-9b346524d003",
"db_currency_code": "sample string 10"
},
"company_type_id": "68271a42-4d0a-4aa4-b989-192434289455",
"company_type_name": "sample string 32",
"company_type": {
"id": "f2b8d4f6-be14-4eba-8660-6e9cf090dea9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b577868d-3c5c-4fd1-aa3a-a793b042378e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0fd44ed7-da17-4921-bfb7-75824b2f90ab",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "443a39bc-098b-4ef0-9aa8-ea285201f325",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5387b04c-0a0f-4504-b241-96b77cda7d01",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d7008424-b1a5-4d69-a57c-8237206edc33",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-06T09:28:23.26517+00:00"
},
"company_sector_id": "2481c2d1-c4be-4856-87c0-edd7f2cb020d",
"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": "f3285d94-c5b3-4f78-b24b-860953ee9eb8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "961a28de-d88f-498b-9095-42b3e5242e9a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a682e690-217e-4655-ad92-cfa81b6e432c",
"account_manager_user_code": "sample string 56",
"company_status_id": "01678625-7f48-4687-925d-6619323e2281",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-06T09:28:23.26517+00:00",
"id2": 60
},
"db_language_id": "1e8a2fec-9566-49e6-9745-1482e43063ad",
"db_language_code": "sample string 7",
"db_title_id": "654f31bc-f69b-4351-b29c-22769a4ed9aa",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-06T09:28:23.26517+00:00",
"create_date": "2026-11-06T09:28:23.26517+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-11-06T09:28:23.26517+00:00"
}