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": "a89d656a-3484-4b73-9d2b-0ca3c95d8d54",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "37274411-fbae-4125-9c3d-7ba1d41370eb",
"company_code": "sample string 5",
"company": {
"id": "ccbfacdd-a50c-430a-852e-fe44f1929245",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-17T02:36:50.7945378+00:00",
"sales_territory_id": "0cb4dcef-f358-43f5-bc4a-7b531920486c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3c00493f-88f9-43cd-8efd-1560a81681b7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "467e38d1-8938-4a48-97c3-8d7bdb1740c3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "48135143-b535-4678-b633-d7f19b7bd055",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf538221-2503-4857-bf37-f33602659141",
"db_currency_id": "952b4a7c-acc3-4a06-a11b-e2f1dfe957fc",
"db_language_id": "7fd8d805-2cb5-4a86-bb4b-c55be3e4d82c",
"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": "2025-10-17T02:36:50.7945378+00:00"
},
"modified_dateutc": "2025-10-17T02:36:50.7945378+00:00"
},
"marketing_segment_id": "e76d992f-a2f7-4798-b094-ca64be326f6d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "54219cfc-6cff-49c5-bf29-0c578b5b0892",
"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": "5e054857-b30d-4c6f-baec-ebf0c7a042e5",
"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": "bb751791-05eb-459f-87fb-6df22787eb2f",
"db_country_code": "sample string 28",
"feelist_id": "51af9898-5ad3-4b96-abc3-ee5f863ac52a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b4ed42e8-6461-4360-8ad0-25ce8d78fbfd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cdf1a886-3af2-49e8-8c9f-241829532fdd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-17T02:36:50.7945378+00:00",
"db_currency_id": "ef3db09f-53f8-4022-bc16-687c535ea2d7",
"db_currency_code": "sample string 10"
},
"company_type_id": "deaafa89-274d-467e-b084-fe5f777c3cdb",
"company_type_name": "sample string 32",
"company_type": {
"id": "119a280c-f261-47bc-8bad-f559d48425ff",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "48c2ddd8-a242-4f93-b27e-aaba33246a22",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b06026ed-2838-42ca-ab66-5d79479a3593",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "67bcaa04-c35e-421b-8c1a-4f3b8daf1ed2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7de0ad91-6264-4b88-813c-bb8813f3306d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "83c3bb58-16dc-4994-93d0-5221a5d6527a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-17T02:36:50.7945378+00:00"
},
"company_sector_id": "0332663c-5055-4916-9392-e0d666f0b5b7",
"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": "8c43d261-ab25-4780-b862-26e4abef5214",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "510c44d0-d9c8-48cc-94e4-d279298c8843",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "89268380-396a-464b-8a68-6515f9a97274",
"account_manager_user_code": "sample string 56",
"company_status_id": "08718e6d-b3cf-49f3-9081-cda4497c2f42",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-17T02:36:50.7945378+00:00",
"id2": 60
},
"db_language_id": "22821342-04cb-4193-bd0d-1df1b4de87c0",
"db_language_code": "sample string 7",
"db_title_id": "f543e449-a79d-492a-8eca-6f0e9e345b54",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-17T02:36:50.7945378+00:00",
"create_date": "2025-10-17T02:36:50.7945378+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": "2025-10-17T02:36:50.7945378+00:00"
}