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": "76341c43-90ae-4cb4-8ead-f4f88785292a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "63a4e2eb-dd4a-4950-bb7e-30d7ccfc8959",
"company_code": "sample string 5",
"company": {
"id": "d4ec8bad-dfd5-4009-8ea6-2eb2258ba03e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-23T00:58:23.8299044+00:00",
"sales_territory_id": "a99ff138-20f9-471e-b49b-3309b33c8953",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9ad15329-2f30-478c-86a5-2bf2f35b6a65",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9d5863e8-543a-4c26-97ba-6136a091ebcf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d7ed6a11-bc0a-460d-9aef-ce4e7d2e16d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6614332a-ecce-41ba-abb1-571c7905118a",
"db_currency_id": "6617bdc6-a713-4519-80e9-09384d85fe29",
"db_language_id": "23c10ddd-15aa-46d8-b3da-7d4edf375566",
"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-09-23T00:58:23.8299044+00:00"
},
"modified_dateutc": "2026-09-23T00:58:23.8299044+00:00"
},
"marketing_segment_id": "041706df-e3ae-4986-bb48-567d10dad62e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "abd74e06-06d5-41f8-9924-5c720a17a803",
"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": "f208c881-6a10-4faa-b309-cc3322b3d45e",
"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": "51002060-c4d8-42c4-bc02-deb700cf7641",
"db_country_code": "sample string 28",
"feelist_id": "fc66aa8f-a754-4db8-8627-01cf7dc89361",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ce26ad1f-3935-4dd7-868f-e7ac9913e1e9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "477fab3a-e4b0-4e0d-b215-89747a17e6af",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-23T00:58:23.8299044+00:00",
"db_currency_id": "e3bebb84-b875-4339-9f34-130ff8c6f8d7",
"db_currency_code": "sample string 10"
},
"company_type_id": "f5a1e9e8-e620-46e5-a87b-1da63a19bd30",
"company_type_name": "sample string 32",
"company_type": {
"id": "b65ecc05-67ee-4885-a697-d3301c6dce40",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "93453bb5-89d1-4478-b273-c3ee610b759e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "23bd16a4-bcc7-46a5-a4c0-4bd1295f71ca",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "29919590-8332-43b1-bfec-b2ef5cca5402",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "55c591fb-e934-4449-af14-b2ebe91b6ce9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "660e5e31-5c07-49c3-bf35-1065f1cc970d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-23T00:58:23.8299044+00:00"
},
"company_sector_id": "6f47fd61-9360-4c28-a1d8-7edb18561fcb",
"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": "17663825-8fee-40eb-afa9-ba705bf5525b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "546803ae-dba2-4ba8-8172-57d8f8b92cd8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "908a499d-63b3-4674-8617-0015c08fa3e7",
"account_manager_user_code": "sample string 56",
"company_status_id": "46b07d1a-4286-4841-8a39-5137825398ed",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-23T00:58:23.8299044+00:00",
"id2": 60
},
"db_language_id": "2ec5d31d-dac2-4ab2-a8ff-6920ca738574",
"db_language_code": "sample string 7",
"db_title_id": "8be9d582-c4c8-4f74-88e1-8c25cfd98664",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-23T00:58:23.8299044+00:00",
"create_date": "2026-09-23T00:58:23.8299044+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-09-23T00:58:23.8299044+00:00"
}