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": "b36068d5-b8e5-43d2-b268-849d7325e2bb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a0e6ca55-3c16-4df1-a0bd-874f0ae3e762",
"company_code": "sample string 5",
"company": {
"id": "744dd18f-a537-435c-942b-eea8c93cbe83",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-08T04:13:36.9414992+00:00",
"sales_territory_id": "fd4ea08d-8c41-4aca-9153-d612a68c31f3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2ff8c960-d59f-4b2b-ac27-6fc48ce1d757",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "04b61fbc-cc0b-4993-b40c-3c1154785845",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4d004bcb-1b9b-4262-9afe-227cadabe428",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b9dd01e-0356-46c3-812d-5024df58040f",
"db_currency_id": "b88a1b4f-174c-4cba-9083-28e55d433623",
"db_language_id": "8ddf7728-43de-4c5c-a1e5-39737ea077b6",
"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-08T04:13:36.9414992+00:00"
},
"modified_dateutc": "2026-10-08T04:13:36.9414992+00:00"
},
"marketing_segment_id": "a721a690-6230-4678-a930-8a94a71e53ac",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "48f676c8-dd84-491f-9610-af495c25bd4e",
"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": "47319dcd-2977-4048-9aa8-f504d3da399d",
"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": "a567e221-a65b-4692-b932-08c17089de5d",
"db_country_code": "sample string 28",
"feelist_id": "3c80f3ee-aad3-4cb5-9a05-04d73264c73b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1ac5763c-5e4f-4346-ac0d-ed83f4b65fbf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ff6472d4-beef-41c7-b969-99119c6ef49d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-08T04:13:36.9414992+00:00",
"db_currency_id": "58ada65a-5e42-48e2-ad4d-bd34c98eb3be",
"db_currency_code": "sample string 10"
},
"company_type_id": "7ae651d7-7ead-471b-b080-2e04e639e993",
"company_type_name": "sample string 32",
"company_type": {
"id": "3f5d30b3-8f97-4df0-81f5-270b2bf0d78c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0e103088-cc57-4000-b552-02f3444b66e6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fa85eed9-e5cf-45bb-a8de-ead8da81786b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3d0130b8-52dd-4946-ad12-a4b7fa449ab1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "aedcd11a-3761-4f29-a94a-b0963123c995",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e2fbcb50-0e2b-4765-be00-599be74f1705",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-08T04:13:36.9414992+00:00"
},
"company_sector_id": "f836bc5b-774f-4cbf-9fa4-e0a883ca1e89",
"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": "3c7f304c-9c8c-45c8-bb92-8750231ee912",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3825c28f-f445-4f0b-bfea-a35f0ace2bc8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "31b6788c-498d-430e-b8bf-0cb70aeef600",
"account_manager_user_code": "sample string 56",
"company_status_id": "16527658-4a13-4dd0-bd34-fd813521805d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-08T04:13:36.9414992+00:00",
"id2": 60
},
"db_language_id": "4b729da5-2fd5-4f07-98c5-7fafd9a31a7b",
"db_language_code": "sample string 7",
"db_title_id": "4b084151-03d6-4c71-b1e0-1ffe4c9cf6c2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-08T04:13:36.9414992+00:00",
"create_date": "2026-10-08T04:13:36.9414992+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-08T04:13:36.9414992+00:00"
}