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": "260223e6-b327-4db5-9eb8-fc2da29eefb6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3fe83d5c-533e-4648-b657-4f967f044159",
"company_code": "sample string 5",
"company": {
"id": "fb2334d1-b0f8-476e-821a-4aea5f1172f3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-13T11:46:48.4385017+00:00",
"sales_territory_id": "c1023594-dbb6-40ba-b6fd-aaac84b12621",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "be1eda69-27d7-46ae-a3e5-7b54c90054c0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1a176f6b-f3a5-4f89-8e93-54f36f37ee0d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1cd23570-1fbc-4028-9196-80241a3f7633",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b55d8a5a-cdae-4557-b4fc-dcce970c79ed",
"db_currency_id": "982987ca-f3ea-4432-8946-70373403c9b0",
"db_language_id": "c5262b53-e76b-4de8-a5ea-9d454620706c",
"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-11-13T11:46:48.4385017+00:00"
},
"modified_dateutc": "2026-11-13T11:46:48.4385017+00:00"
},
"marketing_segment_id": "6cb35023-3140-48d9-905f-efae5169355a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a0c10571-e747-42b2-aafc-9e9e21135fed",
"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": "2b191431-36fc-43d5-9302-ccff737f4713",
"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": "1141feb7-2da5-44e0-9952-402419431f47",
"db_country_code": "sample string 28",
"feelist_id": "e9a4d960-11e7-400a-a827-59ae8fa64f26",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "57eec3df-cf71-43b2-9623-f998e162b703",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e674e7bc-d014-4d63-823b-45eacc4868df",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-13T11:46:48.4545195+00:00",
"db_currency_id": "21332f3d-d178-4807-b03b-2fdd1ad0157a",
"db_currency_code": "sample string 10"
},
"company_type_id": "9ca097d3-bb08-43fb-9e1a-eaf9b887d7f0",
"company_type_name": "sample string 32",
"company_type": {
"id": "93b7c66c-4a88-436f-9517-648d92f1cec7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b59556ca-ac96-48c3-af2a-2a4848f4d911",
"sales_organization_code": "sample string 5"
},
"db_language_id": "23fb6347-7947-4f8b-a3e9-b53771cbd6ed",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "45d6ee1d-3af0-4094-b58d-5071311dae63",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9a38e019-fdcb-4048-a71f-7248784bbb47",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7c04a939-4f58-4c24-b716-e483617c1507",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-13T11:46:48.4545195+00:00"
},
"company_sector_id": "8a27afd3-f162-4f89-9a46-0781fcee78ff",
"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": "356a456f-2c7f-40d0-ba78-642527c43d87",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "264220a7-8030-403b-8499-a0098e60c059",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cc9c56d9-f063-49fa-b4e5-962052c57a14",
"account_manager_user_code": "sample string 56",
"company_status_id": "fc8620b0-6433-4c0d-8482-d21333809e27",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-13T11:46:48.4545195+00:00",
"id2": 60
},
"db_language_id": "05549521-0303-42e4-a477-d0a32ec0ac1c",
"db_language_code": "sample string 7",
"db_title_id": "70320094-ed4b-44ad-ad8c-378e04dd88d4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-13T11:46:48.4545195+00:00",
"create_date": "2026-11-13T11:46:48.4545195+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-11-13T11:46:48.4545195+00:00"
}