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": "b34885a4-d93a-4344-9074-11f44cdaae2c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4bbb17bb-83da-47bd-9f89-e93fe359f836",
"company_code": "sample string 5",
"company": {
"id": "07fa9455-9f3d-48a8-b03f-b29e29a58deb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-04T07:34:20.4184021+00:00",
"sales_territory_id": "74a09bf0-d79c-4d48-852a-be5e2c99c01b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a9f20482-3dc7-4d73-8d94-a730931402c8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "33fe98c5-e072-4f2d-b392-6ac857e57c1c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0b9de165-bcfd-461f-8020-4773cd983afa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b2a88a6c-871d-4dbd-badf-0a040d1433d9",
"db_currency_id": "bc9334ae-4b88-478e-8fd8-b6892646a632",
"db_language_id": "d857565f-0b01-44a3-998e-5c5223f38ac7",
"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-03-04T07:34:20.4184021+00:00"
},
"modified_dateutc": "2026-03-04T07:34:20.4184021+00:00"
},
"marketing_segment_id": "e3df3bc0-d96e-4fa3-8b34-363752896639",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "44f3582f-61f6-4681-ad29-6919d1538268",
"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": "385fe784-8899-428c-b4f8-f9f2b67cb5a6",
"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": "427070bb-39c2-435d-a80d-d8d21fe73f20",
"db_country_code": "sample string 28",
"feelist_id": "7c90bc0b-65d7-43f8-bcb5-c47196b01270",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bd010c0d-5b17-458c-80a3-a74723714118",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4bfdeaa2-cc77-442d-b6ae-a05d547fdf4a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-04T07:34:20.4184021+00:00",
"db_currency_id": "ce268eae-d382-4997-9fa4-9237ffb73a69",
"db_currency_code": "sample string 10"
},
"company_type_id": "3e543e0e-6e7e-44d8-9fb1-678264ae99d3",
"company_type_name": "sample string 32",
"company_type": {
"id": "eaf8a6d8-c2b5-41ee-b5ce-d42de36203db",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b09e563d-f1e2-473c-ba67-629b9a94ec1b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b3c0e792-66e4-4176-a1ad-c859cdb512a5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2c2e864d-fc37-4f6a-ad5b-78782289b98c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "15159c9f-c2d9-43dc-99f9-6265f9175e08",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "234ea6c1-123f-4640-a486-577b160cfcb9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-04T07:34:20.4184021+00:00"
},
"company_sector_id": "bfabeaad-3abe-4509-98df-13555434504f",
"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": "bf2720ea-6d76-4c40-b6d7-35e1fe0c0ca3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "09ce30cf-a6d9-4d70-b5f4-289b3be5d910",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0584b1e2-bf44-430e-87fa-28ee1be3776c",
"account_manager_user_code": "sample string 56",
"company_status_id": "a5bc69ae-41f1-47cb-8bbb-22f882dcb22f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-04T07:34:20.4184021+00:00",
"id2": 60
},
"db_language_id": "6e331cdb-1ccf-458d-884e-6294c7b2089f",
"db_language_code": "sample string 7",
"db_title_id": "c2cf1ab0-5ecc-46ca-9187-184cf139c308",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-04T07:34:20.4184021+00:00",
"create_date": "2026-03-04T07:34:20.4184021+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-03-04T07:34:20.4184021+00:00"
}