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": "882b2a6a-1e9c-4a22-911c-404e0c8ff615",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "66a72077-c223-43c3-9a91-9dfed75c88b4",
"company_code": "sample string 5",
"company": {
"id": "10c0a425-a559-4fe5-8709-2748976424dd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-07T03:49:18.7290305+00:00",
"sales_territory_id": "dd8f3605-c53b-44f7-af52-76dbcf1e6961",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "780dafa0-80d4-4c60-ab53-6730eced0987",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "51509bed-db7a-4109-838c-4fe2feed1254",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5cea3e8d-88ee-4a33-b177-c2241a5409cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e0c5fdd9-b573-4f00-bda9-3324d5275651",
"db_currency_id": "c116c087-92d6-45ff-90f4-a6d8cf4446c1",
"db_language_id": "faf1a99f-280f-4492-af13-14dddf7e5699",
"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-04-07T03:49:18.7290305+00:00"
},
"modified_dateutc": "2026-04-07T03:49:18.7290305+00:00"
},
"marketing_segment_id": "d5a7cb7d-ec99-4ae8-8b12-63e73dd3b620",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7f29a898-caa7-463c-b58c-c9ef25234652",
"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": "b82526f3-9043-42b6-b9a4-98982e77b5f8",
"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": "cd84d19b-74f0-484f-9cd3-f1b62a09526c",
"db_country_code": "sample string 28",
"feelist_id": "a1a0304e-32d7-43d9-9faa-8329962636ec",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "08c14066-de87-44a9-9944-b3d8bd9a4a18",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "82b3f9e9-22bc-41d0-b553-838d16e46702",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-07T03:49:18.7290305+00:00",
"db_currency_id": "80290921-04b7-4889-9160-3c3b259dc469",
"db_currency_code": "sample string 10"
},
"company_type_id": "320c1498-5d40-49a4-9fc8-aaf22d215bc7",
"company_type_name": "sample string 32",
"company_type": {
"id": "dd7b4173-067f-47ca-94fd-69e6651b02f8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "41d71e05-43fd-4d16-8902-ac3e56f5df62",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f2328078-e18b-4ac8-a174-cc46d215c822",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7d1b3b0f-c622-4525-8f5c-f0152683f850",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c5f32bec-fa56-44b0-9c68-d0e2c9feef1c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fdba73e9-4dd8-4f16-92f0-333c51eb7c0c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-07T03:49:18.7290305+00:00"
},
"company_sector_id": "7811a76d-141b-4174-a8ba-f0aff29de1fe",
"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": "13ded98a-7737-41de-9509-47bb71cef01d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5315cc27-ee83-405b-8573-825b35f8decd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "30376f8f-5950-40e2-bcd9-19722dc1fa20",
"account_manager_user_code": "sample string 56",
"company_status_id": "f3cc3a87-0cf8-4623-bd7c-27c47fd10c27",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-07T03:49:18.7290305+00:00",
"id2": 60
},
"db_language_id": "874e8c53-37a8-4f94-99a9-094fc72d7d59",
"db_language_code": "sample string 7",
"db_title_id": "18a73295-431d-444b-8815-22a6a59c5290",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-07T03:49:18.7290305+00:00",
"create_date": "2026-04-07T03:49:18.7290305+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-04-07T03:49:18.7290305+00:00"
}