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": "2b7bd0b0-b949-47e8-a6e9-7f24c384a167",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b7aa2a0d-5f53-47bd-9955-dc3460f7e5d3",
"company_code": "sample string 5",
"company": {
"id": "72f088ff-902d-4b50-8172-4b415d8bf6da",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-17T12:26:10.5483016+00:00",
"sales_territory_id": "9ca9d54d-4fba-4df2-8e66-66d3696cd81b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "11eba418-6fcb-43d7-a169-eb92bdc4df9f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "16ffc2d6-f0e0-4752-9342-1e1e4e09d472",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "084b1629-1ae9-4078-9367-8498f76f8258",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94d86f67-f689-419e-8f60-dabb7208a212",
"db_currency_id": "d2d93ad7-0a92-4b21-9397-cd5310bdac66",
"db_language_id": "63e5ba90-953c-4ae7-a2a3-c448c7ad2eec",
"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-17T12:26:10.5483016+00:00"
},
"modified_dateutc": "2026-08-17T12:26:10.5483016+00:00"
},
"marketing_segment_id": "052497d6-be2f-419e-aa7a-92be9c3e29d4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3666ec22-c854-433d-859c-a2513e268072",
"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": "60be9b90-c572-4801-8200-78b21b2be9c1",
"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": "901b07f5-db00-4f76-af18-619a7bb87698",
"db_country_code": "sample string 28",
"feelist_id": "e31360ec-88b3-4720-ad48-24444fb30028",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ab3b90ed-b859-4fe2-aa66-e3f8cfc1d708",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "55e1c05f-deff-421d-a42f-a20927a6612a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-17T12:26:10.5483016+00:00",
"db_currency_id": "565cf7cf-30ef-42b5-8b3d-e0d6b54b4004",
"db_currency_code": "sample string 10"
},
"company_type_id": "f1b303f7-84de-491e-aea4-33ac0c961ed6",
"company_type_name": "sample string 32",
"company_type": {
"id": "62d215a6-76f6-4658-825a-862587f232cd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "144cdc02-4599-41d6-9070-dd7b0966c1cb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5344bbb6-1693-411d-8ec5-c06b7381783c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "54f1ffb7-94a5-41cc-923c-7988529c7469",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a8f32785-210c-4710-9049-b2e0ec320128",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e66274de-438c-40a0-888f-76ba382d6556",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-17T12:26:10.5483016+00:00"
},
"company_sector_id": "e04683f6-a89c-4cef-b9d8-0dbc858c1329",
"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": "7afbf681-bf0c-496c-a5c3-7592e89b2e88",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b081f0f9-bac5-4fba-affb-fcf29d7dd35c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "60d4025e-f6f0-458b-93f9-824769ea1e1c",
"account_manager_user_code": "sample string 56",
"company_status_id": "d0a43450-2296-48f9-a27e-96256bf7edf0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-17T12:26:10.5483016+00:00",
"id2": 60
},
"db_language_id": "faf3b394-e99c-484f-b725-2cd9a6c5db9c",
"db_language_code": "sample string 7",
"db_title_id": "c5cfdbe8-49a1-4fa7-9af8-8dd3d1e3a333",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-17T12:26:10.5483016+00:00",
"create_date": "2026-08-17T12:26:10.5483016+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-17T12:26:10.5483016+00:00"
}