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": "ca52a902-fd58-415f-b716-eb1810c410d0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "530a99c7-0163-4299-a25b-dbe705dbcd53",
"company_code": "sample string 5",
"company": {
"id": "5d30d4b2-dc67-49b5-a962-046d92b7d1c6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-13T05:11:40.5455351+00:00",
"sales_territory_id": "9a6cd6c7-3b16-4801-8ac9-bdc47b0e81b7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1ebf897d-c960-4dac-9f7e-47b8309aed16",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b019190d-f323-4f33-af32-3172b9409302",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c4411d60-7a96-4c77-a91b-0fecd8fc3215",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9bd5c0e-653f-45f0-9edb-a0fe97a26bf9",
"db_currency_id": "155e2c17-83d9-4000-942e-d10044023aba",
"db_language_id": "33a0fba1-943e-45a9-b081-1a1a0774fd8e",
"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-04-13T05:11:40.5455351+00:00"
},
"modified_dateutc": "2026-04-13T05:11:40.5455351+00:00"
},
"marketing_segment_id": "089a9095-b897-4a8d-90fc-67e3f84e5284",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "36cb357f-9c49-4a67-aaf2-7a39ca0bc0a6",
"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": "4608aa3b-cb8b-4e92-a382-4b98c559c211",
"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": "c98255d2-917a-412f-8e71-bcc9168ffc55",
"db_country_code": "sample string 28",
"feelist_id": "513056c0-c713-4e5f-9601-037e911b5c4a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3231308e-e046-482c-ad50-f956c13c465f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3e21e1f1-b09e-4f3d-a6a4-d0ea54a2a969",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-13T05:11:40.5455351+00:00",
"db_currency_id": "810ce7f2-ccd2-4f5c-a90a-047db903d3e5",
"db_currency_code": "sample string 10"
},
"company_type_id": "902fd778-510b-4a55-b6b4-4ed193727c38",
"company_type_name": "sample string 32",
"company_type": {
"id": "fe67ebed-042b-42ef-a80f-e7afd4bd7c81",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bc83fecd-30bc-4a03-9671-6ccace1e39d6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6d949dcb-c254-4600-8018-36414f05ea9b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fb8677ef-8ac2-4cbe-a16a-a96e32ef849b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a9ffbd4d-024e-4ee5-a779-d2ff0c5b24fb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "17fc9238-95e2-472c-8e7a-d8e53dcc9b33",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-13T05:11:40.5455351+00:00"
},
"company_sector_id": "08a157e5-0ac9-4946-9af4-5d3da31953ed",
"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": "d4e21126-d50b-43b7-8da2-daad34e26b22",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b9f783c7-c7cd-4955-a3ca-9a5d74194964",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cab0854e-5963-45f9-95ad-77a81291e2dd",
"account_manager_user_code": "sample string 56",
"company_status_id": "08e21e72-efa6-4b23-afa7-9e876023a035",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-13T05:11:40.5455351+00:00",
"id2": 60
},
"db_language_id": "ea1c2261-4a28-4fde-b4f0-aec4bd99a4f4",
"db_language_code": "sample string 7",
"db_title_id": "20f4a39a-0b90-4908-a3f9-b0eda9ec11d2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-13T05:11:40.5455351+00:00",
"create_date": "2026-04-13T05:11:40.5455351+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-04-13T05:11:40.5455351+00:00"
}