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": "34024813-94b1-474a-abae-a5f075b51596",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4f047225-42f3-491c-8176-fe756a544453",
"company_code": "sample string 5",
"company": {
"id": "6722877c-1d0e-4302-88fe-da577fb8273f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-27T02:59:21.9015416+00:00",
"sales_territory_id": "e3b6f9c3-9d1f-4c99-a91b-768cfd0f0b98",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2b47370c-cf3a-427a-8d9d-93531d8a7fa6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "96fb82c5-eaf1-4b4f-b665-325d4381a70f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f886d755-60b0-484f-ab84-49fb6d87a45c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52a9d3ef-8438-47ee-8654-ace146a82b2d",
"db_currency_id": "c9eb5b94-0cd1-4548-b7fc-e34f5341a422",
"db_language_id": "3e58d418-becc-425a-a575-d13c073981d1",
"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-06-27T02:59:21.9015416+00:00"
},
"modified_dateutc": "2025-06-27T02:59:21.9015416+00:00"
},
"marketing_segment_id": "498a5ba9-a592-4486-879c-48672b49b3f4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "28202711-1079-4cf1-8567-84287afdda5a",
"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": "89a6d3b3-38f2-45ed-a858-995dfda95b18",
"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": "6df85591-fc50-4e8b-924b-676db94f4ec2",
"db_country_code": "sample string 28",
"feelist_id": "1228ce59-b4ce-4e4a-a9e4-7744821c5be1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "165eeb2e-3f6d-4ccd-8449-b330483c632c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a6d8717f-def2-4168-8b40-45811009f1a0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-27T02:59:21.9015416+00:00",
"db_currency_id": "203e1e99-4fe3-4cac-a0b8-324fed040c29",
"db_currency_code": "sample string 10"
},
"company_type_id": "605bc76f-d1de-4e5a-8bc8-aa87be621f9c",
"company_type_name": "sample string 32",
"company_type": {
"id": "72e711f6-0340-4f4c-bb52-d20892258e3c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "04a49695-a099-476f-86ce-e6ba7f611f8f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a4319252-a6d3-45e4-b2d9-6eadc82cec8b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9f9e893d-440f-40b6-8aef-745e7a1373d7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b90aacd7-8053-4d32-a818-612a876847a7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f2e454b4-1f6a-43d6-b75b-3fbe82839de7",
"name": "sample string 2",
"pm": "sample string 3",
"description": "sample string 4",
"reference_back_office": "sample string 5",
"activated": true,
"modified_dateutc": "2025-06-27T02:59:21.9015416+00:00"
},
"company_sector_id": "c349da22-0f73-49c2-ae6a-81f3aa7ab7ea",
"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": "652c616f-10ed-43cd-97ed-bd22d4b08bc6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4893ee9b-a03f-450b-83e6-be2a2a7367f6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9e21c108-6708-41c5-b325-a188507c821a",
"account_manager_user_code": "sample string 56",
"company_status_id": "463901af-ed61-4646-9759-4965f06602e9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-27T02:59:21.9015416+00:00",
"id2": 60,
"po_number_required": true,
"invoice_contact_id": "dbe77b69-880a-45e0-967b-76b92b56f249",
"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": "4cb0bbc3-8f6d-4bb7-8a1d-dda1f4419a57",
"db_language_code": "sample string 7",
"db_title_id": "785fd0e8-dfbe-4bd1-8eac-5d7b7b66123e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-27T02:59:21.9133808+00:00",
"create_date": "2025-06-27T02:59:21.9133808+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-06-27T02:59:21.9133808+00:00"
}