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": "bf7098cd-5b26-4f4f-95c8-663210c1b6b6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "64b69a87-b4bd-4e9c-b983-beadcf5cc6f7",
"company_code": "sample string 5",
"company": {
"id": "fee56836-9e46-4c8b-8aad-1f30889050dd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-18T21:48:53.7045923+00:00",
"sales_territory_id": "02a55879-6c02-42c6-8b4a-aca01fd6e2b8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1bb348fe-62e6-45f6-85ab-c873f3883131",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1017eb1b-d90b-41a0-b7d7-5217bf643d07",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "66e040c9-ef14-4a15-85f1-e88c06fc5e9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ac51418-a067-4e00-b78c-f4379bec8c1b",
"db_currency_id": "e8e86c28-9d4f-44ec-9469-fd05762986ef",
"db_language_id": "34eb0d14-7dbe-4122-b50e-9f9296b0b847",
"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-08-18T21:48:53.7045923+00:00"
},
"modified_dateutc": "2026-08-18T21:48:53.7045923+00:00"
},
"marketing_segment_id": "a4b24d58-5833-47a1-a7bb-5990d4f582e9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4313d08d-5afd-4619-9d66-531ef43b36ed",
"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": "cbbdfbbc-4d56-45af-8e31-38e956480904",
"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": "b3c0c33d-bf58-4934-9a22-58403e3364f1",
"db_country_code": "sample string 28",
"feelist_id": "1a262323-5666-4175-880e-9879c9045293",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0f257569-6b6f-400a-88b2-86ade91bc135",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5c04c15d-4b74-4eac-b7d0-b5ab94c00a25",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-18T21:48:53.7045923+00:00",
"db_currency_id": "d9ce9c68-525e-4114-9e67-0a8146d5ffe3",
"db_currency_code": "sample string 10"
},
"company_type_id": "00f75261-a48f-4522-b7cf-8e238b65258d",
"company_type_name": "sample string 32",
"company_type": {
"id": "eed16fed-524d-4d69-92e2-caf9c5a69c38",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2881be3d-ed9f-4daa-9938-05c829298533",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b85e1153-e3b4-40f9-a1cd-7b0d3a5b813a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ad76f8ba-3e9b-42a6-ab10-d7edb4aaee55",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "da16e30f-997d-44e2-8590-b6d77817512a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1c9fdf38-5ea1-4b01-92e1-6d71026b3206",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-18T21:48:53.7202189+00:00"
},
"company_sector_id": "c929f65e-e60e-4376-9e38-f6c7af089c74",
"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": "5e52a0ab-ce14-4020-a5c3-90ffe239413a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7227c1f0-0f6f-42e9-b24e-6ded0f8c976c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f6883c12-52aa-405f-8075-db104328b8ff",
"account_manager_user_code": "sample string 56",
"company_status_id": "126e1ecb-9123-4869-b6c0-1e875fb6b6af",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-18T21:48:53.7202189+00:00",
"id2": 60
},
"db_language_id": "6a1027c0-ee13-4efe-83f7-5ea3c1128950",
"db_language_code": "sample string 7",
"db_title_id": "94fac9a1-ad55-4199-97fa-11d4ba61d3a1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-18T21:48:53.7202189+00:00",
"create_date": "2026-08-18T21:48:53.7202189+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-08-18T21:48:53.7202189+00:00"
}