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": "1f7a35f3-bad0-4d68-bf8d-4f2982e7f34a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ddb3bd3d-7ebb-4d79-8165-51b24ea6f354",
"company_code": "sample string 5",
"company": {
"id": "16c20d6c-c3e1-4fa9-a727-09516b49819f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-06T18:00:54.5257832+00:00",
"sales_territory_id": "592268e5-e1ea-448b-bbf6-7ad2103020a2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c463f588-0417-443e-8be9-e3e3727d17cd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "582486f8-4cef-48cc-b2f6-5ce1efb646b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0986dfcd-78f4-4c1d-b70c-5c235cf0bdea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bc88baf3-f9fd-45e2-8d25-58d973eac045",
"db_currency_id": "4910bfb2-debf-4d45-8074-41e588fa01d3",
"db_language_id": "5bb42b33-23e1-4418-a0e1-56f124587fad",
"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-12-06T18:00:54.5257832+00:00"
},
"modified_dateutc": "2025-12-06T18:00:54.5257832+00:00"
},
"marketing_segment_id": "c9dfeff5-51a5-47e8-93ae-4c7fd0c2fb9e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2b72124d-80ba-4950-986f-8401d3cff743",
"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": "fc1a8743-5312-4a71-9725-48dcb4b907d8",
"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": "82bcb005-14ef-442a-b0a5-47fa1a4dcc0c",
"db_country_code": "sample string 28",
"feelist_id": "bd2483fa-e0d3-40a8-8275-a1d2ba3c8181",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5045beb0-993c-4f99-9776-ac6adedd1a5b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3915cc26-a79c-4323-bcb7-b40e59252a67",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-06T18:00:54.5257832+00:00",
"db_currency_id": "567daac1-559e-42e4-9b59-b6ff739d07c5",
"db_currency_code": "sample string 10"
},
"company_type_id": "2f762291-f319-46bc-a129-0f0a863e2a83",
"company_type_name": "sample string 32",
"company_type": {
"id": "9c6ce1d5-3f99-40ca-881b-df41acf95a56",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "09597be0-8c85-4fda-802b-0978502dec81",
"sales_organization_code": "sample string 5"
},
"db_language_id": "06f3291f-01d3-41a3-831c-d33b60260320",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3572eeff-e58e-4560-975d-0df2ffe9b934",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5f5c6d05-7366-4a98-a40d-71b70785abeb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4454d1a9-b1cd-4aeb-bd24-9a2439df4a0d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-06T18:00:54.5257832+00:00"
},
"company_sector_id": "47bf1ec3-449c-4bab-87f1-0a1ade080213",
"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": "276d2aee-9197-49da-992f-7c062c257b09",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5d7c92b0-7651-4ca2-b91e-1d6236611f28",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e8e0b64b-160c-412d-ba14-a4623c3bba34",
"account_manager_user_code": "sample string 56",
"company_status_id": "a1531bc7-4b35-4f77-8230-ed1af08dea8d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-06T18:00:54.5257832+00:00",
"id2": 60
},
"db_language_id": "31d4473f-d632-4dd1-9843-4ca35ac31d0e",
"db_language_code": "sample string 7",
"db_title_id": "c7b89634-9fd2-42da-ab7e-c05fc4f41e8a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-06T18:00:54.5257832+00:00",
"create_date": "2025-12-06T18:00:54.5257832+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-12-06T18:00:54.5257832+00:00"
}