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": "0d2079d9-c58f-4d53-8655-a5f61975dcdd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2b35bb05-3ee6-47da-aa1d-ec7ff71b84c4",
"company_code": "sample string 5",
"company": {
"id": "12227940-5e75-4359-908c-76d2cf7a57ec",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-24T10:19:31.214445+00:00",
"sales_territory_id": "ba945dae-14fc-4675-94aa-ae2e4e428bc4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2a1db0b3-d990-470e-beab-7d3f602c2550",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ecdbd1ed-0087-4aa3-a832-dcf1a772669e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f1beea7a-cb9e-4904-a742-0eda39e359c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cbb9f07d-16dc-46cf-9c40-f400cf43d97c",
"db_currency_id": "d257b42d-2dc4-4f83-ad5d-b5397182881f",
"db_language_id": "0b0158a6-0a02-4d69-a781-733dca254f87",
"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-07-24T10:19:31.214445+00:00"
},
"modified_dateutc": "2026-07-24T10:19:31.214445+00:00"
},
"marketing_segment_id": "586597ba-1fe4-442f-b4ad-281ab84f52a9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "adb53a10-61a8-43e4-a824-a5fdbb560993",
"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": "88bb2907-9cbf-4000-8f80-354d92d57c6c",
"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": "091bd92a-8836-4a63-a116-644c98e0a369",
"db_country_code": "sample string 28",
"feelist_id": "c00662d5-87c1-4663-8e03-c86a700a19e5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "55f61f99-3ae6-44ef-a36a-b4050dee3050",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1126635c-580e-425e-a976-d60f4cbcf0f0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-24T10:19:31.214445+00:00",
"db_currency_id": "49bfa0b0-8f92-4130-8eb2-59a48a4e9908",
"db_currency_code": "sample string 10"
},
"company_type_id": "ecb4d73e-9e0a-4702-81e2-718534ff0b07",
"company_type_name": "sample string 32",
"company_type": {
"id": "77c6fbd7-5af4-4c26-84a2-189e95bd1109",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "378f3ded-cb41-4ee5-8886-fad5be4454a4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ab6015d6-300c-4abc-9c75-9fd6605045b9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6c33a8e3-f529-4e89-8eef-b6437cee4632",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "edde8ec2-a654-4f73-8ec1-cfeba746ccca",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "64ac93d3-b97c-4b9c-b795-fb9d0394936e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-24T10:19:31.214445+00:00"
},
"company_sector_id": "ab5e5781-f4e7-44ee-99e7-58a2c3651b9c",
"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": "be3efa08-7cb2-40c8-b1e9-d3e5ad075543",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "08c96b7c-9320-433a-81fa-1f64732c9919",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c276fb8c-7241-4aa3-b19e-f9d352e57119",
"account_manager_user_code": "sample string 56",
"company_status_id": "75e104e6-0aeb-4713-80b7-dcec83cf0718",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-24T10:19:31.214445+00:00",
"id2": 60
},
"db_language_id": "0799a196-5f27-4e7e-ae21-94f57f0a8531",
"db_language_code": "sample string 7",
"db_title_id": "8f55b198-a81f-4ecd-a61c-9f2359411352",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-24T10:19:31.214445+00:00",
"create_date": "2026-07-24T10:19:31.214445+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-07-24T10:19:31.214445+00:00"
}