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": "b298fde3-9bce-4e10-846d-78e0d5281426",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "df80b2f0-54bc-4ded-a5cb-eec3a2ee1fc8",
"company_code": "sample string 5",
"company": {
"id": "921dc654-6f32-4d5c-92b2-b306f075675c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"create_date": "2026-10-10T05:09:52.9403757+00:00",
"sales_territory_id": "fb92e3b3-8834-4f30-a155-b72f0cea97af",
"sales_territory_code": "sample string 8",
"sales_territory": {
"id": "ed7dca45-328c-402a-b7ff-3971902c39eb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a5bac2df-441c-4692-b925-5ea615a2aa6c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "96d59e7e-845e-4f08-b95b-5d83fd1955c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d78436be-daea-4091-884f-5f752c0e8d4c",
"db_currency_id": "64791ef0-f8df-4bba-83f3-33dab0838262",
"db_language_id": "65f5065c-367e-4509-9ade-74b2c94e8b1e",
"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": "2026-10-10T05:09:52.9403757+00:00"
},
"modified_dateutc": "2026-10-10T05:09:52.9403757+00:00"
},
"marketing_segment_id": "00e1c659-0efb-4c86-bfae-b8dbe1ea77fb",
"marketing_segment_code": "sample string 10",
"sales_organization_id": "8a98ac83-7e72-4e98-9a6c-6c7bf7c2b726",
"sales_organization_code": "sample string 12",
"company_sales_status_code": "sample string 13",
"vat_reg_code": "sample string 14",
"is_working_address": true,
"parent_id": "f7b9a87e-dba8-4057-96bb-0bb6a41fd0f1",
"parent_company_code": "sample string 17",
"phone": "sample string 18",
"fax": "sample string 19",
"url": "sample string 20",
"email": "sample string 21",
"street": "sample string 22",
"street_number": "sample string 23",
"city": "sample string 24",
"zip": "sample string 25",
"db_country_id": "23304ce8-1d1b-47f6-b30a-4fd10cd8ef3c",
"db_country_code": "sample string 27",
"feelist_id": "5714907c-93aa-4e56-8170-e094eca22444",
"feelist_reference_back_office": "sample string 29",
"feelist": {
"id": "49e0f78d-46f4-4480-8fed-a091fa7fdaee",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "29e2e293-7ce3-469d-8a40-0a072a344d81",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-10T05:09:52.9403757+00:00",
"db_currency_id": "c2637536-2513-4ad5-9a4a-61e2bc3309d9",
"db_currency_code": "sample string 10"
},
"company_type_id": "f23727d3-9be2-44cc-b9ea-4bd0fcda818c",
"company_type_name": "sample string 31",
"company_type": {
"id": "1b6f4033-5b18-4fb2-817d-0b4e17459d73",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1a239746-411c-4fc3-8750-e7974e2869ba",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3863e267-9cff-414c-b68f-e362f3d2cc59",
"db_language_code": "sample string 33",
"code": "sample string 34",
"article_price_label_id": "d2303208-b606-44ea-951a-e132e003fdd4",
"article_price_label_code": "sample string 36",
"db_payment_method_id": "31986116-c529-4224-a594-c7392e4f1f65",
"db_payment_method_reference_back_office": "sample string 38",
"db_payment_methods": {
"id": "1d8941c1-1cb7-4114-b4b6-04f08de7b941",
"name": "sample string 2",
"pm": "sample string 3",
"description": "sample string 4",
"reference_back_office": "sample string 5",
"activated": true,
"modified_dateutc": "2026-10-10T05:09:52.9403757+00:00"
},
"company_sector_id": "ef928074-1f86-4e20-b5e1-c85fe98aa2c4",
"company_sector_code": "sample string 40",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 43",
"bic_code": "sample string 44",
"specialities": "sample string 45",
"register_number": "sample string 46",
"register_city": "sample string 47",
"bankaccount": "sample string 48",
"mobile": "sample string 49",
"service_manager_user_id": "e1a8bb07-840a-421f-a38e-ad6598221017",
"service_manager_user_code": "sample string 51",
"finance_manager_user_id": "263a1448-8a34-418a-83d7-f0cc016d8cc4",
"finance_manager_user_code": "sample string 53",
"account_manager_user_id": "19328404-294e-4e97-8b9a-c8a56733613e",
"account_manager_user_code": "sample string 55",
"company_status_id": "6dfc04a6-2b02-4888-bf19-69f8136d81dd",
"invoice_email_to": "sample string 57",
"modified_dateutc": "2026-10-10T05:09:52.9403757+00:00",
"id2": 59,
"po_number_required": true,
"invoice_contact_id": "63ed00c3-2209-44ca-93fb-498d09bd7c38",
"due_monthend": true,
"payement_conditions": "sample string 63",
"udf1": "sample string 64",
"udf2": "sample string 65",
"udf3": "sample string 66",
"udf4": "sample string 67",
"udf5": "sample string 68",
"udf6": "sample string 69",
"udf7": "sample string 70",
"udf8": "sample string 71",
"udf9": "sample string 72",
"udf10": "sample string 73",
"udf11": "sample string 74",
"udf12": "sample string 75",
"udf13": "sample string 76",
"udf14": "sample string 77",
"udf15": "sample string 78",
"udf16": "sample string 79",
"udf17": "sample string 80",
"udf18": "sample string 81",
"udf19": "sample string 82",
"udf20": "sample string 83",
"udf21": "sample string 84",
"udf22": "sample string 85",
"udf23": "sample string 86",
"udf24": "sample string 87",
"udf25": "sample string 88",
"udf26": "sample string 89",
"udf27": "sample string 90",
"udf28": "sample string 91",
"udf29": "sample string 92",
"udf30": "sample string 93",
"udf31": "sample string 94",
"udf32": "sample string 95",
"udf33": "sample string 96",
"udf34": "sample string 97",
"udf35": "sample string 98",
"udf36": "sample string 99",
"udf37": "sample string 100",
"udf38": "sample string 101",
"udf39": "sample string 102",
"udf40": "sample string 103",
"udf41": "sample string 104",
"udf42": "sample string 105",
"udf43": "sample string 106",
"udf44": "sample string 107",
"udf45": "sample string 108",
"udf46": "sample string 109",
"udf47": "sample string 110",
"udf48": "sample string 111",
"udf49": "sample string 112",
"udf50": "sample string 113",
"udf51": "sample string 114",
"udf52": "sample string 115",
"udf53": "sample string 116",
"udf54": "sample string 117",
"udf55": "sample string 118",
"udf56": "sample string 119",
"udf57": "sample string 120",
"udf58": "sample string 121",
"udf59": "sample string 122",
"udf60": "sample string 123",
"udf61": "sample string 124",
"udf62": "sample string 125",
"udf63": "sample string 126",
"udf64": "sample string 127",
"udf65": "sample string 128",
"udf66": "sample string 129",
"udf67": "sample string 130",
"udf68": "sample string 131",
"udf69": "sample string 132",
"udf70": "sample string 133",
"udf71": "sample string 134",
"udf72": "sample string 135",
"udf73": "sample string 136",
"udf74": "sample string 137",
"udf75": "sample string 138",
"udf76": "sample string 139",
"udf77": "sample string 140",
"udf78": "sample string 141",
"udf79": "sample string 142",
"udf80": "sample string 143",
"udf81": "sample string 144",
"udf82": "sample string 145",
"udf83": "sample string 146",
"udf84": "sample string 147",
"udf85": "sample string 148",
"udf86": "sample string 149",
"udf87": "sample string 150",
"udf88": "sample string 151",
"udf89": "sample string 152",
"udf90": "sample string 153",
"udf91": "sample string 154",
"udf92": "sample string 155",
"udf93": "sample string 156",
"udf94": "sample string 157",
"udf95": "sample string 158",
"udf96": "sample string 159",
"udf97": "sample string 160",
"udf98": "sample string 161",
"udf99": "sample string 162",
"udf100": "sample string 163"
},
"db_language_id": "520651f4-2459-4194-af7e-f106eca739c7",
"db_language_code": "sample string 7",
"db_title_id": "6d52594a-64de-4169-a608-7dc7157f5341",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-10T05:09:52.9403757+00:00",
"create_date": "2026-10-10T05:09:52.9403757+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": "2026-10-10T05:09:52.9403757+00:00"
}