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": "966a78a6-415e-4c1e-b4e6-b622f506b8e2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8ac5edd2-e4b2-450f-8164-5cec2fe9c287",
"company_code": "sample string 5",
"company": {
"id": "4d7d4e15-33aa-49cd-ac94-635073c9df81",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-26T18:13:02.9921143+00:00",
"sales_territory_id": "5616720b-4ecb-453e-981b-740493665905",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a9636438-c693-4649-8ce8-6b0313867bb5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8c18cced-9ccc-47ec-8204-c151c7e99f3e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "78a9860a-63aa-4bf9-995e-d4cad9d883cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf8f4811-0f90-4fdc-99f6-51c6ac50c748",
"db_currency_id": "13786357-fe0c-4041-8b02-3e2896583531",
"db_language_id": "3a80ba13-c0ae-45b6-8b66-de2db29e9b99",
"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-26T18:13:02.9921143+00:00"
},
"modified_dateutc": "2025-04-26T18:13:02.9921143+00:00"
},
"marketing_segment_id": "019cfb36-5c4f-4bc2-a132-1713610dbe65",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "102bf292-2aef-421f-bea5-4c21a3464f46",
"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": "2607f416-a6c2-400b-88b4-1f08c45a4e98",
"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": "ad54acfe-f59d-439e-ae57-0fa8581934fb",
"db_country_code": "sample string 28",
"feelist_id": "e5df3373-57d9-42ee-b477-dbc9f3030ce9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "77158cf7-7932-4a52-aa26-b42887003957",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2e5547a6-f02a-4d05-ab8b-711029cfd8ce",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-26T18:13:02.9921143+00:00",
"db_currency_id": "d60400be-ef42-49fe-a058-383c676cc6e3",
"db_currency_code": "sample string 10"
},
"company_type_id": "c3054607-5a4d-4597-b30d-aa6d8edb60ca",
"company_type_name": "sample string 32",
"company_type": {
"id": "cb8d9fb6-8ecc-4296-9a1f-5527ebb5a06a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "50c75563-9704-438e-9a00-7a79c093e1f1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "67637dee-530c-492c-bcf6-718c718b0a5e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "01bf69d0-ff50-4afd-b44a-f557aba6c7df",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "eb79c561-ce0b-4ddf-b05d-dd3aeab2aaec",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "326f7d54-74e0-4a66-969b-76d425553c66",
"name": "sample string 2",
"pm": "sample string 3",
"description": "sample string 4",
"reference_back_office": "sample string 5",
"activated": true,
"modified_dateutc": "2025-04-26T18:13:02.9921143+00:00"
},
"company_sector_id": "59820c49-fc38-4a72-b230-b8751e23ec7c",
"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": "d5fd330f-de05-4c38-ae1c-2b7a057f9e97",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "82ac9bf5-2b51-448a-bc75-57d974023a87",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "32d38797-d549-4347-8abc-8716030d2e00",
"account_manager_user_code": "sample string 56",
"company_status_id": "9550826f-bb91-4786-8762-96e4fb032544",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-26T18:13:02.9921143+00:00",
"id2": 60,
"po_number_required": true,
"invoice_contact_id": "b6645f7b-554e-4427-8657-67c4bea3b360",
"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": "841aff1f-30c2-4964-be9b-a8bf710ed5a8",
"db_language_code": "sample string 7",
"db_title_id": "220259cf-6bce-496c-99dc-4256a58a0efb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-26T18:13:02.9921143+00:00",
"create_date": "2025-04-26T18:13:02.9921143+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-26T18:13:02.9921143+00:00"
}