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": "bca8d24f-372b-482f-a3a0-913338767256",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2f69f6b9-4596-4d0c-a23a-cd1b69eff510",
"company_code": "sample string 5",
"company": {
"id": "9636611b-2f85-45d1-8cb2-e319546a8e31",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-18T20:07:38.9930449+00:00",
"sales_territory_id": "d4e44782-0da0-43f0-973c-98bdb48a5216",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4cdffc04-33c2-42ec-aa2a-374488cacfbe",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "82f9b6d5-7d19-43b9-a171-bf230ec89465",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "40ea2267-f46c-4821-95a7-0699ab14fe4c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bce2104-baf7-46be-854f-a473ebb71fd7",
"db_currency_id": "340b4e2b-25e8-4df3-914a-3b0fb4fcb05f",
"db_language_id": "fb33edae-8365-4085-99fa-53519c758a0c",
"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-18T20:07:38.9930449+00:00"
},
"modified_dateutc": "2026-08-18T20:07:38.9930449+00:00"
},
"marketing_segment_id": "4e13fcd2-8507-446a-b4a4-8fb9a3a45305",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4a068ed7-680e-4444-af53-3477958a4560",
"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": "cb7c2c64-fd81-40f8-b0e6-994d3ae871c4",
"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": "d5973e58-f1ef-4e01-834a-6460f10de56a",
"db_country_code": "sample string 28",
"feelist_id": "53b1e2a9-00fd-4951-abdc-376acd2128b9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "32efdc9f-fe80-4565-9272-8088052c9b51",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "81247af7-831e-498e-8183-6cf5880198a6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-18T20:07:38.9930449+00:00",
"db_currency_id": "47f78c38-015b-4401-8dc3-089935ccd57f",
"db_currency_code": "sample string 10"
},
"company_type_id": "2eb0cc9f-d16f-4ff8-a4e6-69d3b2809bb0",
"company_type_name": "sample string 32",
"company_type": {
"id": "26a71b27-5880-49e3-9656-48f5b9737cc3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "12294270-bca1-45f9-97cd-8321d6f53eb5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2685ab91-ac1e-4e94-8ecf-5489597cb7cf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "67d4f779-1f55-4367-8a7c-7ef5cea96e19",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e50e6d7e-acba-41e4-aeb4-98150bd2eaad",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bec9993d-bd04-42c7-9596-444c3ddc7ca2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-18T20:07:38.9930449+00:00"
},
"company_sector_id": "a20bec85-edb3-4290-a7bf-d393d47d3791",
"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": "cdf17814-a420-4639-9e95-72e902f27835",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3fdb2f27-4ca1-40d7-b409-332612457978",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "05d7281a-ec64-416a-bf46-ed5849ab4e7e",
"account_manager_user_code": "sample string 56",
"company_status_id": "6e6b0b93-30dc-4c0e-9a8b-4c62ff2eb311",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-18T20:07:38.9930449+00:00",
"id2": 60
},
"db_language_id": "f36306ef-da18-486d-bdb3-34b07f8c2cca",
"db_language_code": "sample string 7",
"db_title_id": "88ea90b0-da07-486a-8230-68d4a455bb13",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-18T20:07:38.9930449+00:00",
"create_date": "2026-08-18T20:07:38.9930449+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-18T20:07:38.9930449+00:00"
}