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": "e3affab0-d84f-49dc-9e2e-59bfdf803736",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "54389bd1-60d9-4ab0-84c6-b5b79f6d2922",
"company_code": "sample string 5",
"company": {
"id": "f6086f4c-8610-4211-bb7a-b93bd5d84843",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-30T04:10:54.9321258+00:00",
"sales_territory_id": "abbd3ae2-4e45-4ce1-b5f8-13c5d00ee964",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ea05b57b-3dcf-4637-9523-8cc133cd615e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5f0775b4-fd5b-40d1-a3c1-7a248e67b4e4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6ba5fc77-7269-4f0d-af45-6cb083c56483",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da31b63b-f5b8-42d1-93d9-cdb62ba0344f",
"db_currency_id": "95bedcad-bfbf-4773-a974-b7d8160e537b",
"db_language_id": "d7abad26-83dc-4a1e-a50f-4b4af3435271",
"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-05-30T04:10:54.9321258+00:00"
},
"modified_dateutc": "2026-05-30T04:10:54.9321258+00:00"
},
"marketing_segment_id": "4f072e47-96f9-422e-9209-06474229b604",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c1c249d8-e2b6-4c9f-8a44-570cc29945cb",
"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": "57840d40-f13e-42aa-81d0-f5108c560942",
"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": "2cc81b76-76ad-4919-8384-303a1e23d5b1",
"db_country_code": "sample string 28",
"feelist_id": "e41b7fb8-8c12-4f7a-8bd3-d6b051e0f3ac",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "75b67390-96e5-43a6-95ad-9adb4379f2c0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ff9715ab-cd7f-4678-9cee-7c21902492f2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-30T04:10:54.9321258+00:00",
"db_currency_id": "06b8a625-ffdb-4b39-8a89-7cf79a45f840",
"db_currency_code": "sample string 10"
},
"company_type_id": "dea3c7c3-8037-4f5f-ae3c-fb7bf6cbe8ac",
"company_type_name": "sample string 32",
"company_type": {
"id": "4630fb4c-518c-4676-a0d6-f6f95e9a9b84",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5053b82-5674-403b-b361-d694260e2626",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ea7ae002-129a-4c3c-adaa-71d38ad46070",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4627a14f-e341-4c81-a081-0db9b055daf6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b4c7dff6-dbc5-4fc3-8cba-5a36c4cba69e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9ec1645f-fe52-4afe-b3fc-7abd91dd7b9a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-30T04:10:54.9321258+00:00"
},
"company_sector_id": "6391fecf-c249-464f-a9a0-bdad31295e51",
"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": "d0199970-b38a-4846-9f89-5d34650ee6e7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bbe258e6-2164-4068-9eb3-8f1d4feb5647",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fa6b7157-c5dd-499f-a45a-395e57dfabfa",
"account_manager_user_code": "sample string 56",
"company_status_id": "d15b0301-a2a2-4da6-b559-bd0762ed4770",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-30T04:10:54.9321258+00:00",
"id2": 60
},
"db_language_id": "1e8f50c3-bafd-47e4-ac67-a379c20fe148",
"db_language_code": "sample string 7",
"db_title_id": "dee29435-1fc1-474a-ac25-f4c438034178",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-30T04:10:54.9321258+00:00",
"create_date": "2026-05-30T04:10:54.9321258+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-05-30T04:10:54.9321258+00:00"
}