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": "e244f6a4-ef6d-45a5-aa60-63e9828ec141",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6ce4e3ff-b7d4-40ea-8b65-84d3436c5616",
"company_code": "sample string 5",
"company": {
"id": "9878923d-be41-404f-bef2-32535fe06b70",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-03T21:05:00.8641118+00:00",
"sales_territory_id": "463e86a9-eba0-4040-a4c1-849b18fecb21",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4a12a364-d47b-4e9e-b674-49868698bce1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ec1cbd61-b375-4909-a0ae-eeeec30fefd4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "34152140-f434-4d6e-8438-806ad379331a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "387d476f-a640-47b0-a8fd-5ae7481b04a9",
"db_currency_id": "63cd2d6d-8981-4cec-9f3c-a3a602440e9d",
"db_language_id": "72684552-5a69-4f2f-955d-c5639db4843b",
"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-02-03T21:05:00.8641118+00:00"
},
"modified_dateutc": "2026-02-03T21:05:00.8641118+00:00"
},
"marketing_segment_id": "1b0ad723-84a9-4dbf-b94f-650a6d64f4c1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a5d0f8d6-b8da-454e-b606-92d43ffa3474",
"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": "6d18ba1f-be51-4d40-ba5b-1f8be20c7abe",
"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": "5abb6e2c-b75b-44f1-bc17-63c086872072",
"db_country_code": "sample string 28",
"feelist_id": "73a89453-c363-4de4-9a5c-b9664089a90f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9207b37c-63a9-42ed-80d1-f201047319bc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "acb35a2f-fc51-4c52-baad-62f87ee49dca",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-03T21:05:00.8641118+00:00",
"db_currency_id": "d5d163e5-4706-4f16-af55-7ed88b90e827",
"db_currency_code": "sample string 10"
},
"company_type_id": "8faf5511-6902-4fab-b7d4-d91500df9b58",
"company_type_name": "sample string 32",
"company_type": {
"id": "a5f1eb0a-820a-4d10-bf52-e1c79f44e4d3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c550d004-5f67-42ec-a209-2f1d133159f5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "adbd08b7-b799-4b83-b341-94ccd16c5c32",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "96999827-9dde-431c-90f4-90b256105708",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a81ca20d-6f0d-4122-a4bd-9caab3255dba",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b3c287bd-70be-4ebf-b412-fffae66baf68",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-03T21:05:00.8641118+00:00"
},
"company_sector_id": "58a45f13-4275-46ac-a500-99a75a3e715a",
"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": "f51435d5-0074-44c5-9009-c7fa9f17cccc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4d7ec511-f6af-4313-9104-a089a0c77965",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "af319178-3d45-4f60-b8cb-213c7a6b01be",
"account_manager_user_code": "sample string 56",
"company_status_id": "bd23a22c-2a24-42a1-b1df-5061a1bcb9df",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-03T21:05:00.8641118+00:00",
"id2": 60
},
"db_language_id": "b4e96137-bd82-4895-9d59-d4bb6013158e",
"db_language_code": "sample string 7",
"db_title_id": "ac2eef89-365c-4b24-8991-6a275c234580",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-03T21:05:00.8641118+00:00",
"create_date": "2026-02-03T21:05:00.8641118+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-02-03T21:05:00.8641118+00:00"
}