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": "0bf296c4-98e2-4f26-a97d-13b8e2de06a3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "47a1fbf2-235c-4c71-b6c8-c3e99e9b0a3f",
"company_code": "sample string 5",
"company": {
"id": "612e55c2-1455-46ea-864b-46446c466f4a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-10T16:39:10.3152635+00:00",
"sales_territory_id": "0cd50183-d9c8-4acf-a48f-d5aa262ba9b9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "091f836b-d497-49fe-91dd-91c9f68953f8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8ddd5957-fbe8-4bf9-a22c-cd81aba8375c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "614f4631-a91f-480c-b76c-35030977f5a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17517d40-0cf2-4058-ac27-fe3bb4169131",
"db_currency_id": "72bcbc14-32c9-4837-96b0-2965f01ad50a",
"db_language_id": "9ca0e3cb-4bf7-439f-b1fc-7a8af2795db5",
"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-11-10T16:39:10.3152635+00:00"
},
"modified_dateutc": "2026-11-10T16:39:10.3152635+00:00"
},
"marketing_segment_id": "9ed2e2d3-5dd4-4298-961c-ea8761ddcc52",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f7f0bcd0-8c67-460f-b51c-60ef0ebeff39",
"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": "4f0057b5-c1da-4cf8-8f86-e57eddad912c",
"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": "d8c0cd24-6292-4282-a96f-64afefa082f0",
"db_country_code": "sample string 28",
"feelist_id": "19931e58-881d-4444-888a-b902f82c32cc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fa55c729-e3be-4a74-8e0d-1c68824be875",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7026fc33-5a0d-4ac0-a5c7-3e207535ae08",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-10T16:39:10.3152635+00:00",
"db_currency_id": "b8796fb9-2bb7-4bd2-a841-0ca736fbb011",
"db_currency_code": "sample string 10"
},
"company_type_id": "f696d9ae-6f8a-4417-a6ce-3ada288d309f",
"company_type_name": "sample string 32",
"company_type": {
"id": "3cb3989f-a10f-4f0b-8b35-bb8cd00185f3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "333db823-a8d8-4e55-bb75-dcb451a93345",
"sales_organization_code": "sample string 5"
},
"db_language_id": "09cbd968-8f6d-49c2-9538-d4ebc6ddebe9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "038128bb-e1b5-4e94-9fe2-fdfb420f1a6d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0501ea6c-1bf6-4f4c-b857-7347e5d7ced4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "df547ad7-5fc6-4c2a-82c7-f7694c46f4f8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-10T16:39:10.3152635+00:00"
},
"company_sector_id": "7879411f-07c6-45f0-9d52-b842214af622",
"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": "ccf15b78-8eae-45da-8d44-c6dada49516f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f9c5689a-abbf-42fe-8b61-35fca4dfc38b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9161a217-fd4e-4680-b57f-a2ce7e218f7d",
"account_manager_user_code": "sample string 56",
"company_status_id": "ea2bcaff-4296-4563-a4a9-afc546fb72da",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-10T16:39:10.3152635+00:00",
"id2": 60
},
"db_language_id": "6dd33b94-6350-45b9-bd3b-7093c749c62e",
"db_language_code": "sample string 7",
"db_title_id": "938edf93-2bcb-4b1f-b5ff-5897d268f8b2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-10T16:39:10.3152635+00:00",
"create_date": "2026-11-10T16:39:10.3152635+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-11-10T16:39:10.3152635+00:00"
}