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
{
"id": "70e4ce47-1464-4519-bed3-b7d0d5db4488",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a1701d1e-e9fb-42d2-a66c-5bad6798083f",
"company_code": "sample string 5",
"company": {
"id": "1a724e17-ccbd-4959-bf70-52ac586c1e33",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-20T10:58:43.5556776+00:00",
"sales_territory_id": "e76c6cd3-85a4-4709-bcd4-6c9976e15ae5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0eb02541-b419-45d7-96da-98c3dcd33b45",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "81be2cb2-a3ae-4029-a96e-d0bc2680578f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9dc884cb-aa6d-45a5-be82-ea8b8181cdcc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff42592a-4a80-472b-8695-3e975b7508cd",
"db_currency_id": "131797d5-a7b4-4d89-a01a-7a63ea8e301c",
"db_language_id": "74246078-8fac-4b1a-af70-07608deb6fd2",
"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-20T10:58:43.5556776+00:00"
},
"modified_dateutc": "2026-11-20T10:58:43.5556776+00:00"
},
"marketing_segment_id": "677d2b7f-1624-4b5e-9990-7ba056f2f6b0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0d1b0207-5605-4776-a06b-cbece8747e61",
"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": "1e336c2f-cf33-425a-9cd9-cd10769e2786",
"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": "406b2f90-fe74-4df9-844c-c97ad182f126",
"db_country_code": "sample string 28",
"feelist_id": "649642b9-0cb0-48af-929c-7a3af7f9e70a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "392d2068-ed72-4372-881e-bd68a2d24fc0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "51917303-c6ec-4cd2-90e7-62d6d503ef85",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-20T10:58:43.5556776+00:00",
"db_currency_id": "514d204b-8868-4563-832f-58b89c0bc66d",
"db_currency_code": "sample string 10"
},
"company_type_id": "485dff9d-dea3-444c-ab73-a89592f3193c",
"company_type_name": "sample string 32",
"company_type": {
"id": "44be508d-4e43-449b-a4fa-4f20f1eb8eb9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "59d582e3-de83-4379-aa82-ac2b4a2fea27",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b7b26ca6-c7d5-409a-9d17-925cdfb964c8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "abfd9bf0-d124-4a5e-8f46-96e287d70476",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a06156e8-0d22-4cb8-acac-dd744862e2c4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "62ad9e3d-8688-42bb-b338-841ef21f60e1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-20T10:58:43.5556776+00:00"
},
"company_sector_id": "4ca34ba3-c453-44c6-9b2e-6cedfc7ce7af",
"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": "0f6f31cf-93f6-4d47-bf7f-800788b57814",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fa19b647-93a6-43ff-abcc-17d3442fbdbc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2f893044-990c-44b5-bd17-a4e7eb985e48",
"account_manager_user_code": "sample string 56",
"company_status_id": "fe214266-ac5a-4dcb-bf6e-1ae51d7f9b96",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-20T10:58:43.5720612+00:00",
"id2": 60
},
"db_language_id": "1d97c713-9cdf-4929-a570-7c798a4c385b",
"db_language_code": "sample string 7",
"db_title_id": "08bb7c94-6747-4cb6-9641-fda8546ba14b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-20T10:58:43.5720612+00:00",
"create_date": "2026-11-20T10:58:43.5720612+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-20T10:58:43.5720612+00:00"
}