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": "793a20e5-11e6-4189-92ba-54be0ef3f5e8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "55298092-d371-46f0-9d04-aca8b8d7f086",
"company_code": "sample string 5",
"company": {
"id": "6f6f4968-43e0-4930-8b21-7537271c0ee6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-07T16:47:57.9473775+00:00",
"sales_territory_id": "88775386-f6d5-4458-8168-13b1a85c88ae",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a0d35d80-8cbd-4385-a85e-73f08a59fdeb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a25077a9-f7a9-4963-823f-f6b0abfa0480",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "72dd5555-cd1e-4ceb-8d29-e49c252559d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c9c2f3e1-acd5-47e2-bba0-23b2595ba281",
"db_currency_id": "b44e2dda-0cd6-4aae-a3be-ec1bf863152f",
"db_language_id": "99893f89-a864-4dd9-a555-27ad24dfc40e",
"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-07T16:47:57.9473775+00:00"
},
"modified_dateutc": "2025-10-07T16:47:57.9473775+00:00"
},
"marketing_segment_id": "ab8d15c2-a212-49c7-96be-b5f3f5b261fd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4fbbd11a-63ea-4b6a-ace6-a7f2ea32b176",
"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": "dbbe585c-2aad-41b1-9f16-bcf76fe0b3e5",
"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": "05a38fe5-cded-4537-a3e3-8e6cad5a774c",
"db_country_code": "sample string 28",
"feelist_id": "ffd93dcc-a055-4f3b-b49b-3ae9ae585537",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "eda893e7-6fdf-43ba-88ff-9d222f1cf05d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0cd0d4fb-9216-47fc-91fd-79903b8cdc69",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-07T16:47:57.9473775+00:00",
"db_currency_id": "bf71e28e-34e6-466e-89bf-ebc130af4a46",
"db_currency_code": "sample string 10"
},
"company_type_id": "e3c69d63-b7d7-4781-9b16-7419515fcf34",
"company_type_name": "sample string 32",
"company_type": {
"id": "b19c7461-8d1b-44a4-b80e-a759981fdb0e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "45d65132-72cd-474b-b8d7-7212bf104867",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ed5f6bed-fced-4ebc-9d90-55d00e13c331",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "047fb088-36dc-468b-b8a8-266e29ebf3af",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "824911b1-8ea3-4b85-ac59-9c2caff111cb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9d641e5e-b7be-4f68-bb51-65bb5be6953d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-07T16:47:57.9473775+00:00"
},
"company_sector_id": "aa4cd7da-5687-4935-9536-c7f108eddad8",
"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": "96ffab8b-2fcf-4c41-9279-4c6977abee19",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "13a1a594-acbe-4153-b6b0-c14b5e144f31",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5fd775c6-3627-4e30-bf94-aad374e909af",
"account_manager_user_code": "sample string 56",
"company_status_id": "8ed0ad7d-3f58-47ec-8c23-432504c257f8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-07T16:47:57.9473775+00:00",
"id2": 60
},
"db_language_id": "5acce7be-2b67-4dd3-bce9-d191a688015a",
"db_language_code": "sample string 7",
"db_title_id": "6f918de4-8c35-496a-afc7-49c52e196554",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-07T16:47:57.9473775+00:00",
"create_date": "2025-10-07T16:47:57.9473775+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-07T16:47:57.9473775+00:00"
}