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": "9b3d2680-9c3a-4e29-83a2-2668b3898948",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bdd5a9b5-f89d-47c2-a667-f89ae742c414",
"company_code": "sample string 5",
"company": {
"id": "ec6529e5-ad1c-4396-82f7-968435d1233e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-27T20:47:47.5977705+00:00",
"sales_territory_id": "ee75e87b-0c40-41e9-a0f9-2c80366dd276",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a31e7ce9-4d7c-4345-9153-37aa15d5c645",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "049cf68d-a9be-4db2-8c07-972445652f20",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f909720c-b4fc-4c31-a2a4-79e50762f3da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "605c5125-af67-4519-9624-51d5c8280620",
"db_currency_id": "09380c29-7a39-4cbd-966f-d82f989802ec",
"db_language_id": "c23d2c44-622b-48d5-9482-c1267660a694",
"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-27T20:47:47.5977705+00:00"
},
"modified_dateutc": "2026-03-27T20:47:47.5977705+00:00"
},
"marketing_segment_id": "c4a53513-73aa-4f17-b798-9600f1b069fd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3034d908-3da5-48d4-a5a1-2ad079fb31df",
"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": "979626c8-f6bb-4617-afa1-a801e87e4232",
"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": "14860005-6068-417a-8bc4-598abc1fba3e",
"db_country_code": "sample string 28",
"feelist_id": "ee291856-ac24-4ae5-8219-29763a184cdf",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ccd7064e-a6b4-43ba-b602-8af398272a47",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3add66eb-b394-4313-9996-5a54a8c91741",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-27T20:47:47.5977705+00:00",
"db_currency_id": "e6831cc5-f9d3-4f27-a8aa-a528e9155154",
"db_currency_code": "sample string 10"
},
"company_type_id": "e008583e-c3b3-4de2-bfa2-dc63401505c5",
"company_type_name": "sample string 32",
"company_type": {
"id": "cc0c6308-51f4-435e-8610-f12463af4673",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9e1104e5-2088-46bc-bc06-b69d6dd79ff5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "46417458-31c1-470b-b64c-dbd9c4ecd42b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d4bf3b27-c800-48ce-bde0-c844bae457ac",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "823fb792-d755-4d25-8213-115dab29f34d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6891b7fd-50ab-4cfb-a2a0-2cd21faf6641",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-27T20:47:47.5977705+00:00"
},
"company_sector_id": "dbecebf2-56a7-462b-bc1a-45137b3aecd2",
"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": "f65f5cc1-0853-4c0a-8407-a25bd9acce2e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4e18400f-1ecd-4fe2-87c3-3b5ed7daf96b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "08454c1d-a152-41b1-9073-8ab7c4e165ef",
"account_manager_user_code": "sample string 56",
"company_status_id": "c8a56548-ce33-4c5d-932f-4c1327522f33",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-27T20:47:47.5977705+00:00",
"id2": 60
},
"db_language_id": "89cc70c2-accc-40bf-bb6a-6580d14afe6d",
"db_language_code": "sample string 7",
"db_title_id": "7f3937bb-9d7f-4fa2-9e2c-d2d5be8a8865",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-27T20:47:47.5977705+00:00",
"create_date": "2026-03-27T20:47:47.5977705+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-27T20:47:47.5977705+00:00"
}