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": "db358e57-70dc-4049-8de6-660f1c6a355c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1162cd44-3781-417f-95b5-f618bde895db",
"company_code": "sample string 5",
"company": {
"id": "941151c7-14c6-4480-8f04-9cf1eb9d7396",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-23T02:13:33.5208594+00:00",
"sales_territory_id": "135ffe99-45f9-46fc-be06-e3e2419d6584",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "83cf698a-a147-4feb-ba7b-88d54b008c21",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2da8ab3e-a76b-4c05-9010-021352979331",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ca2a5825-643f-4583-a863-99bd0b43bf52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3d34bd9-1274-4cf6-8347-6ae1c46160fb",
"db_currency_id": "a4119a07-9c4b-4349-a82a-a4ad76c12311",
"db_language_id": "7878ea90-0cc6-409b-912b-3c8170fda90a",
"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-23T02:13:33.5208594+00:00"
},
"modified_dateutc": "2026-09-23T02:13:33.5208594+00:00"
},
"marketing_segment_id": "08e22b59-7779-4ffb-ac4d-9c5b0b9f67ef",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d01c2f7f-aab6-4caa-81a9-af14e2508dba",
"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": "53b3a390-1999-4ee5-ae67-2137735d1510",
"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": "cc53a81c-c461-4306-b6c2-204ae3cea93d",
"db_country_code": "sample string 28",
"feelist_id": "31f4da1f-0504-4f05-8119-e387c4677b25",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3396d3ac-ebd1-4450-99e7-b61f48a7b433",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7b00bcde-2499-41c6-b78b-e27fb9cadb02",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-23T02:13:33.5208594+00:00",
"db_currency_id": "e91d10dd-2406-413b-b27e-6dabf11dc9ca",
"db_currency_code": "sample string 10"
},
"company_type_id": "c747cb30-3976-411f-94de-49724738434c",
"company_type_name": "sample string 32",
"company_type": {
"id": "4851d6b2-bce7-45cc-85c9-a027dab0ed5b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d79660a1-31d9-4fa8-b800-7bac0f263ed5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8a85c452-8dbf-4661-8a04-7d0921409100",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3698a9b5-5e8f-4453-887a-d35c65331dc2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "948d031c-23eb-44d0-ad09-7d98d67f2cf2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "83a12c67-974f-4c68-9e44-d07fcbf7a3ef",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-23T02:13:33.5208594+00:00"
},
"company_sector_id": "4e8cc332-d4c1-485b-9cd0-282e47c0b126",
"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": "65161541-23a2-43d2-986e-fce87d682ad4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "839d6318-d5ad-48e7-9510-c04d33f200b3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "038e2410-0b92-43b2-935f-26a053aea5f3",
"account_manager_user_code": "sample string 56",
"company_status_id": "9bef076c-1ed8-4032-94bd-4b82f180ca1e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-23T02:13:33.5208594+00:00",
"id2": 60
},
"db_language_id": "f130bd9e-24d9-4e95-a397-9d12f95e1092",
"db_language_code": "sample string 7",
"db_title_id": "6d80bf42-9388-4726-8d34-0a0936c50a54",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-23T02:13:33.5208594+00:00",
"create_date": "2026-09-23T02:13:33.5208594+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-23T02:13:33.5208594+00:00"
}