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": "7a0efe86-0920-4eba-8631-f132340c0f22",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4aa7f982-3d73-4923-8b65-3c96a5f42fe4",
"company_code": "sample string 5",
"company": {
"id": "b2cd5541-f85c-4977-b093-2226741d1d75",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-25T05:17:29.1779168+00:00",
"sales_territory_id": "84cf07ff-24c3-43a9-bd67-ecead2db5a2b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5cd1fc52-5fda-4ee4-b195-b9fb32e6a737",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "888e38db-4cd8-4e54-b52e-357080d8b1ca",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bc656f87-d317-4bf8-88a9-ebf4bf867280",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6aeb9125-a77f-4947-847c-0d5bd543f02a",
"db_currency_id": "0f7ac0c3-6407-45d4-87e0-900dc5e29a8a",
"db_language_id": "a3b76267-0f51-483e-b185-5021e34bbd47",
"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-02-25T05:17:29.1779168+00:00"
},
"modified_dateutc": "2026-02-25T05:17:29.1779168+00:00"
},
"marketing_segment_id": "cb04b5f2-a9d6-4b7f-98ca-01fa97ddfcf6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b3025908-b64f-4bd2-b24b-6c9f100cb9cf",
"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": "2ddcf173-6703-4904-bb30-732f209a6041",
"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": "5f9334ee-1aa2-4b5e-8979-190b42715ffe",
"db_country_code": "sample string 28",
"feelist_id": "8a029a88-865a-4ebb-9e29-374db22a412d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ff39b36c-20e1-4186-a3a2-0c7def6595a3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "024518cc-5559-40c0-9f18-c251b8e38c10",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-25T05:17:29.1779168+00:00",
"db_currency_id": "3e7974c7-336b-4c93-873e-b19560c43093",
"db_currency_code": "sample string 10"
},
"company_type_id": "06185d76-9e8c-4f70-be6c-b5a60ceead99",
"company_type_name": "sample string 32",
"company_type": {
"id": "204035f3-2a95-4809-84be-eb24e2bf5a8a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d2e75792-29c9-4ffe-8301-e0f3c0c44351",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9710ab2b-5077-4b6f-9fd8-32c0f1b0ac04",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d9057896-c518-4355-be5b-afd3c6b304d0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "86656057-ea08-414c-9e2c-1f7b97a5d273",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d08f5126-a936-4ef8-978a-7248238c78c1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-25T05:17:29.1779168+00:00"
},
"company_sector_id": "6cb5ea1d-8536-4512-ba0f-b3e0519d3f56",
"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": "547ac6f7-4872-4dd9-a905-0080852283e2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "78590917-1521-4537-a04c-d0b3de217f5b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8ea1dfb2-8035-41e1-80bd-a84239ac4afc",
"account_manager_user_code": "sample string 56",
"company_status_id": "277b171a-edd1-4291-acf6-305b164440e6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-25T05:17:29.1779168+00:00",
"id2": 60
},
"db_language_id": "67fe4c9c-7350-4ff3-8cdf-fc4d4b3ae2cf",
"db_language_code": "sample string 7",
"db_title_id": "e81e7d0a-2442-4ce0-85f0-19e368b63b1d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-25T05:17:29.1779168+00:00",
"create_date": "2026-02-25T05:17:29.1779168+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-02-25T05:17:29.1779168+00:00"
}