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": "09ea3e09-ed6e-4d14-a0fe-de128ec51cd3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4f19eee8-aefc-41ad-a100-77fa4fb53d5b",
"company_code": "sample string 5",
"company": {
"id": "b52897c9-852c-4cc2-bf28-589725e0825a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-26T19:04:15.1932807+00:00",
"sales_territory_id": "edbb8a65-234b-4af6-bd80-a40917bc1f78",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9b34ee57-0701-42e0-82a7-ee6979b3a95d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bf515846-c617-4e3e-ada6-16721cf05817",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "57f82e38-3d96-4473-a787-3156b752d8e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "824e90b7-473c-4bbf-9fd6-50261afd380d",
"db_currency_id": "e5285434-f1a2-42a6-aaad-8af77a28e8a4",
"db_language_id": "03ffe91e-ea0a-439c-b02f-34190f75ff18",
"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-04-26T19:04:15.1932807+00:00"
},
"modified_dateutc": "2025-04-26T19:04:15.1932807+00:00"
},
"marketing_segment_id": "818aa671-e67c-4bac-983f-17e44a8a95b9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bccd5c54-8c6c-4c4c-aed0-5a4668157224",
"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": "60cc7e4f-6a07-401b-8b99-64d1abd2ca28",
"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": "14cf825a-4f6a-4887-94a6-79d501fd6af5",
"db_country_code": "sample string 28",
"feelist_id": "aa02c48e-72e7-4b64-b9fe-dcfce4e7d6bf",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fa309cb0-9790-4977-a133-4d0b2c4c827e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9d265009-416f-4589-9cdd-e129114e3d08",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-26T19:04:15.1932807+00:00",
"db_currency_id": "e8e96d0a-afba-4476-93ab-19819f4eea4a",
"db_currency_code": "sample string 10"
},
"company_type_id": "2644d101-303a-4d06-bbf6-8d8bd5f5ecf9",
"company_type_name": "sample string 32",
"company_type": {
"id": "831dcdd4-90d3-43fd-8741-b1677d137d59",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3dc43e06-9328-4edb-91b3-fced4e5ea6cb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "639b90d4-1f36-4737-8838-679176264280",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a3573673-e333-460a-ad1d-23b4e959166c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "80490d41-cda3-4a6e-98bd-8ca1c2cd9965",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "61a6e284-5625-4b6b-be28-8633d37274d3",
"name": "sample string 2",
"pm": "sample string 3",
"description": "sample string 4",
"reference_back_office": "sample string 5",
"activated": true,
"modified_dateutc": "2025-04-26T19:04:15.2060323+00:00"
},
"company_sector_id": "1b0aec65-c4f3-44f6-84da-ba023fb88595",
"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": "c602c270-0bb4-41a2-ad33-6436e582a63a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1ab33b39-50ca-4a12-8bba-5e5af8354bcf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9eeb7b30-8f3a-447a-8008-2b7301593518",
"account_manager_user_code": "sample string 56",
"company_status_id": "d76bda08-ae88-4590-8380-f9cf0cd23402",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-26T19:04:15.2060323+00:00",
"id2": 60,
"po_number_required": true,
"invoice_contact_id": "790dbe91-5f0e-4977-b186-a67c0d6b1b49",
"due_monthend": true,
"payement_conditions": "sample string 64",
"udf1": "sample string 65",
"udf2": "sample string 66",
"udf3": "sample string 67",
"udf4": "sample string 68",
"udf5": "sample string 69",
"udf6": "sample string 70",
"udf7": "sample string 71",
"udf8": "sample string 72",
"udf9": "sample string 73",
"udf10": "sample string 74",
"udf11": "sample string 75",
"udf12": "sample string 76",
"udf13": "sample string 77",
"udf14": "sample string 78",
"udf15": "sample string 79",
"udf16": "sample string 80",
"udf17": "sample string 81",
"udf18": "sample string 82",
"udf19": "sample string 83",
"udf20": "sample string 84",
"udf21": "sample string 85",
"udf22": "sample string 86",
"udf23": "sample string 87",
"udf24": "sample string 88",
"udf25": "sample string 89",
"udf26": "sample string 90",
"udf27": "sample string 91",
"udf28": "sample string 92",
"udf29": "sample string 93",
"udf30": "sample string 94",
"udf31": "sample string 95",
"udf32": "sample string 96",
"udf33": "sample string 97",
"udf34": "sample string 98",
"udf35": "sample string 99",
"udf36": "sample string 100",
"udf37": "sample string 101",
"udf38": "sample string 102",
"udf39": "sample string 103",
"udf40": "sample string 104",
"udf41": "sample string 105",
"udf42": "sample string 106",
"udf43": "sample string 107",
"udf44": "sample string 108",
"udf45": "sample string 109",
"udf46": "sample string 110",
"udf47": "sample string 111",
"udf48": "sample string 112",
"udf49": "sample string 113",
"udf50": "sample string 114",
"udf51": "sample string 115",
"udf52": "sample string 116",
"udf53": "sample string 117",
"udf54": "sample string 118",
"udf55": "sample string 119",
"udf56": "sample string 120",
"udf57": "sample string 121",
"udf58": "sample string 122",
"udf59": "sample string 123",
"udf60": "sample string 124",
"udf61": "sample string 125",
"udf62": "sample string 126",
"udf63": "sample string 127",
"udf64": "sample string 128",
"udf65": "sample string 129",
"udf66": "sample string 130",
"udf67": "sample string 131",
"udf68": "sample string 132",
"udf69": "sample string 133",
"udf70": "sample string 134",
"udf71": "sample string 135",
"udf72": "sample string 136",
"udf73": "sample string 137",
"udf74": "sample string 138",
"udf75": "sample string 139",
"udf76": "sample string 140",
"udf77": "sample string 141",
"udf78": "sample string 142",
"udf79": "sample string 143",
"udf80": "sample string 144",
"udf81": "sample string 145",
"udf82": "sample string 146",
"udf83": "sample string 147",
"udf84": "sample string 148",
"udf85": "sample string 149",
"udf86": "sample string 150",
"udf87": "sample string 151",
"udf88": "sample string 152",
"udf89": "sample string 153",
"udf90": "sample string 154",
"udf91": "sample string 155",
"udf92": "sample string 156",
"udf93": "sample string 157",
"udf94": "sample string 158",
"udf95": "sample string 159",
"udf96": "sample string 160",
"udf97": "sample string 161",
"udf98": "sample string 162",
"udf99": "sample string 163",
"udf100": "sample string 164"
},
"db_language_id": "47df024a-82d1-4287-8417-d3a4fa20315b",
"db_language_code": "sample string 7",
"db_title_id": "502d7b0e-164b-4206-9bc7-93dc2a06013a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-26T19:04:15.2060323+00:00",
"create_date": "2025-04-26T19:04:15.2060323+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-04-26T19:04:15.2060323+00:00"
}