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": "d08cf9d1-8faa-4f62-a952-804519a9fe89",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4712ea19-9bed-4b09-9192-e3948809cf7f",
"company_code": "sample string 5",
"company": {
"id": "c0a1be05-b994-46d4-9db1-9d45425208b2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-23T18:20:22.9679621+00:00",
"sales_territory_id": "b13c7bfd-bcd8-4eae-bbae-1308dfdd7b37",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d7e83b5b-bf97-4880-a985-9a781d4bcf01",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1df89087-b0fc-4671-8b38-47ba11c7c791",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3d569245-19a2-48b9-824e-626428825205",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9febeac0-09bb-4088-ad44-b5cac483f532",
"db_currency_id": "f9d8fcee-3e97-46e6-b41b-3c4b5a5dfe9e",
"db_language_id": "3529cffc-dde6-481a-a3f8-abbe7540ac9d",
"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-08-23T18:20:22.9679621+00:00"
},
"modified_dateutc": "2026-08-23T18:20:22.9679621+00:00"
},
"marketing_segment_id": "f6202263-4947-414d-94ad-cace8572e926",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b3f2ce5f-c439-40d2-b798-9123e2dae3c8",
"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": "d4e93c0d-8785-411c-9450-89e4ebbe4763",
"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": "0b9899c3-a45a-45e7-99ea-f3aa9a811202",
"db_country_code": "sample string 28",
"feelist_id": "36650be0-37be-4cc1-84d6-1a7e4c426724",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8c3170b9-2f17-4029-be08-3a9ac93f1958",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "09ea5b3a-132e-48cb-aad2-cd7b793b9bcf",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-23T18:20:22.9679621+00:00",
"db_currency_id": "fe9ab4a6-1943-40dd-ba97-f4a47570c258",
"db_currency_code": "sample string 10"
},
"company_type_id": "328e6312-ffad-494d-99c6-f83358446254",
"company_type_name": "sample string 32",
"company_type": {
"id": "07b4db0a-0ecb-478f-b567-e86a2b6aecdf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ed3d1e0e-29a4-49ed-8c4b-585ff5a0b4af",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8ed6def9-c267-49ab-822f-4ae421a0f9a8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "972047bd-93c3-4cb6-8771-ffa82aae7d02",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2bba2481-1bfa-4afc-89bf-2e1d21b6c439",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "781beec2-036d-47f8-b100-d5a136dba3b6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-23T18:20:22.9679621+00:00"
},
"company_sector_id": "a1daf188-e706-4055-b264-5e1f5373adfd",
"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": "2f9a2046-96e7-45c3-8f47-84a915107720",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3c32b0f2-17e1-4a55-bf2e-c9f8cd0d05e2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ed2d41e3-7082-46ef-a735-7f178fbef5c9",
"account_manager_user_code": "sample string 56",
"company_status_id": "b879e33d-7298-4a09-a09d-b5303a7fa0c6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-23T18:20:22.9679621+00:00",
"id2": 60
},
"db_language_id": "95bcfb02-763f-481b-89eb-b3076de67ac9",
"db_language_code": "sample string 7",
"db_title_id": "1c9e7e3a-91bc-40fa-93f8-f1520445b5c9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-23T18:20:22.9679621+00:00",
"create_date": "2026-08-23T18:20:22.9679621+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-08-23T18:20:22.9679621+00:00"
}