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": "644d8cf7-65d1-4452-bcee-d2e346dfe40c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d4841926-1ac7-406f-a422-d68b9f5e6966",
"company_code": "sample string 5",
"company": {
"id": "acfc0125-0329-4f0d-b54b-db362a7100ed",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-08T22:36:27.548012+00:00",
"sales_territory_id": "46a6fbd7-5fa3-4a6d-8ccf-b5e0d23dc9e7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3d1379dd-f993-409c-bfcf-9e8fb8d3720e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7b2ce4d0-6fd7-438b-bb8d-a1130896db07",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "67e6b9bb-220c-4edf-b197-1b7a8d86cc65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be1265d9-2b1b-4f13-a8ef-06182fce555d",
"db_currency_id": "929449f4-5915-4209-a765-c81a55389cc3",
"db_language_id": "302fcf2e-bd21-463b-a3b4-e69e090d9c32",
"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-08T22:36:27.548012+00:00"
},
"modified_dateutc": "2026-02-08T22:36:27.548012+00:00"
},
"marketing_segment_id": "dfdeb043-e75a-479e-b8ad-a9146f8410a6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bd423da3-e74e-4beb-b64a-ced59f1f4864",
"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": "b2395588-6a7c-4ed4-9aaf-f8d7c6e8de37",
"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": "c0e3850d-1a17-4490-862e-e4b40f4454f0",
"db_country_code": "sample string 28",
"feelist_id": "b8b4ce4a-8f11-436b-ae1c-2ff044b15e39",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0ed05f34-cf38-4297-bfdb-a5f9dab3c093",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2fd4ffea-9fda-4554-bf8a-16aa94a0d985",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-08T22:36:27.548012+00:00",
"db_currency_id": "e03a0f7b-3028-40e2-951e-e9537279b6b1",
"db_currency_code": "sample string 10"
},
"company_type_id": "62946e9e-978e-408e-9f1d-343aa8deedce",
"company_type_name": "sample string 32",
"company_type": {
"id": "924e0831-fe85-4ef1-a9bf-ac4ab0153382",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c3303fe1-8528-4b0f-8e9c-2bf014bd28a9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "05199bc9-ac02-400e-8644-f8c68fb77461",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ba08c565-6dcc-4ef1-a8ee-76f56b7fa9de",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "71a31fd0-521e-4439-8488-1f7dd1cca2f3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "acd7eb00-35d2-45c6-bfe6-da54e61406cb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-08T22:36:27.548012+00:00"
},
"company_sector_id": "f7b0df74-69e3-4a4c-b56b-bbc8bcae7a47",
"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": "d2d529c1-5b0e-4ce9-bde4-ec38a322eeea",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2285061e-d1b5-4644-83fc-4f0b374bf931",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a5fcc723-5256-405d-8f45-1442d0f2f1ce",
"account_manager_user_code": "sample string 56",
"company_status_id": "5cf632c7-03dc-4647-bbeb-8409dc1d36d1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-08T22:36:27.548012+00:00",
"id2": 60
},
"db_language_id": "3b4aa92f-08eb-4004-b017-a5ce294dbd1e",
"db_language_code": "sample string 7",
"db_title_id": "8b8183be-6913-47f6-97b0-d9bb8a9fa071",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-08T22:36:27.548012+00:00",
"create_date": "2026-02-08T22:36:27.548012+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-08T22:36:27.548012+00:00"
}