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": "265a40c7-6950-4fe8-a731-855a2abb3fa3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3f7fc019-2c2f-455b-ab9b-fecd1a2a9314",
"company_code": "sample string 5",
"company": {
"id": "ce5edefb-0006-4998-8d53-a11d6749270d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-14T17:01:17.2356926+00:00",
"sales_territory_id": "cc226e7b-e171-4408-a37f-ac690038f8ef",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "af5dd15d-dce2-4f3d-b683-7b26e263b45b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9145cfa7-4bbd-4d7b-a7e8-8399cef799d8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5cbdec8f-2615-44a8-a580-dce71618bd98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f6d8cfb7-4402-4f45-bca8-0bf27618af5a",
"db_currency_id": "6488fd1b-4814-4f5c-a01a-d21058aa9d5c",
"db_language_id": "76abc760-dfde-4f43-b4de-1c707932ce0d",
"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-08-14T17:01:17.2356926+00:00"
},
"modified_dateutc": "2026-08-14T17:01:17.2356926+00:00"
},
"marketing_segment_id": "0d6cef12-6dc8-489c-8ebd-78bc5fadece0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "70c31621-9c22-46ab-9683-33be111287af",
"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": "f7205c89-afff-475f-b3b9-8673b3f207e7",
"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": "bde12cb3-37f2-4de8-a8c9-1349c146cc97",
"db_country_code": "sample string 28",
"feelist_id": "15201e7d-faaa-424d-866f-f52b0b6cb547",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "279ca4ba-5d15-4fa0-a261-e191874cca80",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "276b00b7-e908-4233-abc3-d0af5ad3f294",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-14T17:01:17.2356926+00:00",
"db_currency_id": "1ff057a8-1f70-462c-8631-ef4732c18167",
"db_currency_code": "sample string 10"
},
"company_type_id": "7759ca4a-b7d6-4b98-9402-c9af771e1a60",
"company_type_name": "sample string 32",
"company_type": {
"id": "374d149f-7a9f-4b6d-8c00-21e04ae09180",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "869c8411-b1b6-4766-a10b-6f76d15bd77a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a75ac164-65e9-424d-8f8d-0c464a6d2125",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8dea6e80-2d19-4876-bb66-1f5b10db8cb3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "284e0bf4-5f3e-4487-b74f-9cebd09132b2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dbb6a82c-26d2-4f59-888b-0454f71bf5ff",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-14T17:01:17.2356926+00:00"
},
"company_sector_id": "d8d9b5d4-c87d-400e-b254-960f170ca7b1",
"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": "bead3bf4-fd18-4b91-90fc-832fb3289950",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2a2f4b33-4e12-4586-ac25-a9aa22d51f75",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2d20b133-ba69-4816-8d4d-35491984166f",
"account_manager_user_code": "sample string 56",
"company_status_id": "56eb9661-27a1-437c-bb8a-e87a608be43a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-14T17:01:17.2356926+00:00",
"id2": 60
},
"db_language_id": "c3fea5a9-83fc-4591-8655-9b88bca58fe1",
"db_language_code": "sample string 7",
"db_title_id": "09b0312e-d657-478b-940a-49c3c1532b26",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-14T17:01:17.2513095+00:00",
"create_date": "2026-08-14T17:01:17.2513095+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-08-14T17:01:17.2513095+00:00"
}