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": "48ce9542-7a03-4120-b492-ba33038a560e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "06aafe46-885e-4236-8d78-68889aa27dff",
"company_code": "sample string 5",
"company": {
"id": "86aeea48-f2da-4ce8-8225-f99b38d95f6f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-19T23:48:22.0647473+00:00",
"sales_territory_id": "b83b7bcc-52d4-4096-a8ca-e4309f07ed89",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "62899e4a-b061-40ba-94a0-cc3b4273c723",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4ea92359-9455-4801-bd11-59b2c31834e9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8ba74aec-febe-435a-8b9e-22bdbc7dc221",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a1a6df78-5bb0-46a9-8e9d-e0d13be76253",
"db_currency_id": "8fa83e1d-23d0-45b2-8610-4597d8786071",
"db_language_id": "53a44eed-4458-4924-bcdf-8ddbf9182bd0",
"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-19T23:48:22.0647473+00:00"
},
"modified_dateutc": "2026-09-19T23:48:22.0647473+00:00"
},
"marketing_segment_id": "e04c83ac-532a-471e-990f-94755096c35d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "11f25cca-1099-4b1c-8911-07741c24f497",
"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": "9578b604-cb91-40aa-8cae-61b9cab80404",
"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": "905f2715-cd71-4a06-b980-e421c9e2c4a5",
"db_country_code": "sample string 28",
"feelist_id": "0b88c98d-999d-429c-90d9-0e5bf1bc2a01",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "75a44af5-652b-40b7-a726-fa24588569e6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "37a0b32e-d02f-4369-a0d0-0f2dad83b29e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-19T23:48:22.0647473+00:00",
"db_currency_id": "ae3eb467-aeab-4cce-b7c9-2deda73f4c80",
"db_currency_code": "sample string 10"
},
"company_type_id": "b6fe3598-89ee-40a9-a344-7e6318cbe4b7",
"company_type_name": "sample string 32",
"company_type": {
"id": "ac6e4f1c-d3da-4e10-acd8-79ea63975e9f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d645296a-a229-4428-8b37-2a413f390973",
"sales_organization_code": "sample string 5"
},
"db_language_id": "92bcb626-5111-47f5-ad7d-070271026976",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "42de6e44-63f6-487c-914c-78a8a74900f4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "835f7645-58b5-472b-9551-e46f2d983f12",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2ffa7a30-cfb2-4564-bfaf-e1bef07d98c0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-19T23:48:22.0647473+00:00"
},
"company_sector_id": "e70bdaf2-554c-4c40-aa35-a0a4c5e1e4c3",
"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": "732fc8eb-ee70-470d-9cfd-5e1baee031c0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cd1f4a1a-9254-4200-a0b3-42f5fd15716e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "40ffc636-f7e4-422c-a6ef-a5aaa8824fd4",
"account_manager_user_code": "sample string 56",
"company_status_id": "d3e4cbff-302f-4f21-b632-cced438489ee",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-19T23:48:22.0647473+00:00",
"id2": 60
},
"db_language_id": "b06c6afc-7cfe-4021-9c63-4a9b7a57482d",
"db_language_code": "sample string 7",
"db_title_id": "2f21a78b-d16f-452f-be4c-ab64bbfc1344",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-19T23:48:22.0647473+00:00",
"create_date": "2026-09-19T23:48:22.0647473+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-19T23:48:22.0647473+00:00"
}