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": "7ff92227-83ae-44dc-883e-e6775d9ef0d0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dd7a1144-d80d-4fec-97c1-306cdfc8e7e6",
"company_code": "sample string 5",
"company": {
"id": "0856c9c1-999f-4a63-8e96-8464a436fc71",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-04T05:20:45.9076824+00:00",
"sales_territory_id": "bfad8905-729a-4e0a-ac8f-23c696cce261",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8bdb7956-c8ff-4062-92ac-6e2732749189",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3ed993c5-9aaf-4007-9898-3ae96936f486",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "92366cc1-9ac2-481d-a9a1-cf52d12a9271",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e6f301c-a8bd-48db-a4f0-0815f65c8d6d",
"db_currency_id": "d9a5078f-f694-4a85-a4ec-374baa7c6958",
"db_language_id": "933091f6-0c30-4fee-b058-d5115fae559d",
"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-03-04T05:20:45.9076824+00:00"
},
"modified_dateutc": "2026-03-04T05:20:45.9076824+00:00"
},
"marketing_segment_id": "b6b93102-0f49-4705-a292-c6bd2e341a98",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "288f3808-b640-401c-8aaa-8e7ea5df52fe",
"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": "da3c6ad8-7bfc-419c-8fa5-2cd9d119ed75",
"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": "ae01a4cc-567e-482b-ae4b-ffb57fa517e5",
"db_country_code": "sample string 28",
"feelist_id": "d74c5d3a-e20a-437f-b155-2cb83f772f07",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dcc63ab0-6d56-495c-9bba-9cd6ae6f6731",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8f756b1a-e619-43bf-ab64-72bccf75da0f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-04T05:20:45.9076824+00:00",
"db_currency_id": "9e510ecc-5318-4935-839d-de15e35f3be0",
"db_currency_code": "sample string 10"
},
"company_type_id": "f92cc119-9dcb-4df8-9dd7-555c5b0246ce",
"company_type_name": "sample string 32",
"company_type": {
"id": "bfa28145-acde-4e3a-9bf1-a5491c022944",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f5287abb-486f-4ce3-9502-d80a9f7734a7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c2780f6a-ba36-4311-b799-80fc4cac1412",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b8677c39-dab0-4d82-89cd-6fd9feb23afd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e294660d-0cd6-4db7-aa2d-bd11fac0a188",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c3268c48-cc08-4f49-b4fa-004f6cd2a03a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-04T05:20:45.9076824+00:00"
},
"company_sector_id": "12f4715c-f107-40db-969f-bf8f199d5df7",
"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": "fd396279-4733-4ec1-a97b-f50781dbb3a8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8522f19c-8472-47ee-b36c-98aadc445229",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "40185d16-4276-427c-a1bb-e5a1d0ebaeba",
"account_manager_user_code": "sample string 56",
"company_status_id": "62d9f43c-555f-4513-83e3-728607553df7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-04T05:20:45.9076824+00:00",
"id2": 60
},
"db_language_id": "2286163e-b5ba-424a-8d35-415575b94029",
"db_language_code": "sample string 7",
"db_title_id": "0fe10ecf-5544-4f14-af50-98911c56b7d2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-04T05:20:45.9076824+00:00",
"create_date": "2026-03-04T05:20:45.9076824+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-03-04T05:20:45.9076824+00:00"
}