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": "0b6c4a22-10d2-48d4-877c-a78c0aa5c9f2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b8c2eb19-c690-4dfa-b0c0-057df1722620",
"company_code": "sample string 5",
"company": {
"id": "ab8682c2-6a03-4005-ac17-9395b91aa35b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-30T07:15:33.9228171+00:00",
"sales_territory_id": "21c240ba-899e-46d7-9e8a-60c74c2361e3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f8fc42c8-956f-48e9-b190-c5b4aade5fce",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "49ee50a1-918b-48e2-b7a1-a7aa67ae6b46",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "45fedb0a-7d41-49bf-8d46-92155c7ed698",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a4987b8-2f4d-4c8d-9ae8-7b0bdf5d231d",
"db_currency_id": "ec876da0-fae7-4fb8-b366-78b2042da46f",
"db_language_id": "d87f5622-3774-4e1a-8331-7e75fff4c197",
"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-30T07:15:33.9526761+00:00"
},
"modified_dateutc": "2026-10-30T07:15:33.9526761+00:00"
},
"marketing_segment_id": "47c47896-c1db-4308-9172-0c3ab02f5ac0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cefca630-6b4a-492d-93f7-9eb462894dd4",
"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": "4144f459-2d90-4953-91f9-97ba4297314d",
"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": "84d966a0-2352-41bc-bdd5-671f1fbf5efc",
"db_country_code": "sample string 28",
"feelist_id": "72fd6251-e833-4a43-92bf-7182a3b54efe",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b5e81d4b-c7c3-468b-b286-075073a68f58",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9ad97c3e-35ef-4127-9cb4-63e6c8762a66",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-30T07:15:33.9526761+00:00",
"db_currency_id": "c608a847-84af-44fa-a276-d2d3dcf589dc",
"db_currency_code": "sample string 10"
},
"company_type_id": "63f1bc8f-2ca7-4992-8fe6-5d1c66c79772",
"company_type_name": "sample string 32",
"company_type": {
"id": "3b513c9e-8c1a-4dc3-bea4-0f6b54c20ca3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "03ff7885-cbef-4631-8405-386bd2cb25de",
"sales_organization_code": "sample string 5"
},
"db_language_id": "01978bce-9f46-4323-80a8-881785f6f6ac",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "29f20c47-ce9d-49ab-8f73-1bee38d9317b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4dd64cab-f2b7-4b70-ab22-d0a01d59b0cc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4bfb65a9-e397-4e4b-9749-a0b1e0a920c7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-30T07:15:33.9526761+00:00"
},
"company_sector_id": "974efe62-8a0e-4490-8ae3-8118825b92fd",
"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": "498a0dba-0319-4598-91d2-08772b9d9dea",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d099999b-c54f-4702-9208-51542ba91f1c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dddb32b6-a153-463b-aa04-fa990c7428f3",
"account_manager_user_code": "sample string 56",
"company_status_id": "a6f23008-18c1-4384-a97b-30fb6b4bbada",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-30T07:15:33.9526761+00:00",
"id2": 60
},
"db_language_id": "c8664c72-799d-4571-99b6-6d80d30a3d97",
"db_language_code": "sample string 7",
"db_title_id": "4fe00d8a-1fcb-45df-948a-67c7e845ff82",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-30T07:15:33.9526761+00:00",
"create_date": "2026-10-30T07:15:33.9526761+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-30T07:15:33.9526761+00:00"
}