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": "3e78bd74-ce2f-4b71-b747-f0e47de1973c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8f479c71-ed11-4392-b8ec-e49f1cce0699",
"company_code": "sample string 5",
"company": {
"id": "6ea20bdc-31f5-493d-a62b-d5477307be09",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-22T12:57:01.9773562+00:00",
"sales_territory_id": "dd6e392d-2fc5-48db-9ff3-211eba08198f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1621a716-52b0-4106-9381-ec95cd4ad465",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "36dc3766-c000-4794-bd49-5d238e47ae67",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "57313ffa-97f1-4b16-aa9d-ba9bc7ba6fc2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7369c4b4-577e-416b-b142-2b5b466660cc",
"db_currency_id": "b56ed7af-6501-45e2-a44c-caaa4d773a20",
"db_language_id": "89edf50e-ee5c-4a08-9f7f-8b4f60380ba8",
"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-06-22T12:57:01.9773562+00:00"
},
"modified_dateutc": "2026-06-22T12:57:01.9773562+00:00"
},
"marketing_segment_id": "db3431f8-7ed6-4aa5-8311-f8126a6d19c7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c614a23c-6c26-4211-bf43-62383a445e91",
"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": "f8e12010-676c-4223-b034-806af1e133c2",
"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": "0587b8ae-3bc0-4577-8662-8d9c7193ebe2",
"db_country_code": "sample string 28",
"feelist_id": "c5fb8e7f-ba6a-467c-a408-786c49230285",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "767e27bf-7d9d-4641-8b33-9dcd3f34d7da",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "810ffcdf-8346-471f-8750-86dff315f29f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-22T12:57:01.9773562+00:00",
"db_currency_id": "048acd89-006d-4cab-a384-e1ea87b0068c",
"db_currency_code": "sample string 10"
},
"company_type_id": "2b54fd9e-760c-4050-92d4-2079de10b150",
"company_type_name": "sample string 32",
"company_type": {
"id": "2b735aac-823d-483b-bce3-198d8a7dcc83",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5b94f119-2859-435a-9168-dfee0fe4771c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4b5266e5-4e46-4601-8800-630ca3eccb7b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "24d07379-c2d5-48bc-974f-933f93a53ea1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b0ea061e-6fb1-4e33-b71b-2baad0810042",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ec647fa3-6b9b-4279-8dee-d3179dcf6267",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-22T12:57:01.9773562+00:00"
},
"company_sector_id": "dc6b6430-d517-47a1-b6eb-592ada18b702",
"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": "9adf2237-5727-454e-89b0-ad5e9689c628",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6002236d-a040-4378-a83a-accf71eaa462",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ba3076b5-a14e-493d-b2dc-403cad904071",
"account_manager_user_code": "sample string 56",
"company_status_id": "cb0a245c-fb81-4e16-a5a6-d7d086e2b7a3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-22T12:57:01.9773562+00:00",
"id2": 60
},
"db_language_id": "806f84cc-4212-4ae0-a3be-f32bdadbd887",
"db_language_code": "sample string 7",
"db_title_id": "904447c0-b32a-4479-a114-5cd79b672d12",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-22T12:57:01.9773562+00:00",
"create_date": "2026-06-22T12:57:01.9773562+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-06-22T12:57:01.9773562+00:00"
}