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": "8d2ef3ef-d41c-4ad4-809f-43e142948607",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b4452770-5209-45dc-94a4-cc247cf22826",
"company_code": "sample string 5",
"company": {
"id": "eb2830d5-720b-4190-bb16-5151cd4669c1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-13T18:44:27.3107675+00:00",
"sales_territory_id": "63f4c994-ff8c-4d29-ae4a-6424152868ae",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "71f6ac8b-5278-4ce2-ab80-026301bfff52",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "80cd349c-0761-478c-92fc-a131b394ffda",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8b1529af-03d7-4c9b-b236-f1443079f56f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6c4650f0-3397-4b44-868c-b5208db140b1",
"db_currency_id": "171dc8bc-f602-4e21-a27b-76bb86e43260",
"db_language_id": "709bddf2-78da-4086-b8a0-23b684859343",
"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-11-13T18:44:27.3107675+00:00"
},
"modified_dateutc": "2026-11-13T18:44:27.3107675+00:00"
},
"marketing_segment_id": "1bcdeecd-452c-46cf-8fc4-5ac631dc1eb3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b3d37db1-2894-4cea-85a1-b8677fac3413",
"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": "b17df4f0-9cca-4bcf-acc3-36aaaa45ce37",
"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": "e8bdcfb7-ccfa-4a76-98d5-b3066f6fd797",
"db_country_code": "sample string 28",
"feelist_id": "0337194f-be32-4b03-985f-aa85d78fb8b0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "78e6f54c-7893-4bfa-8a1d-07f01f6b440b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6151cd71-a1ca-48c8-87a7-d4638d1a2a21",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-13T18:44:27.3107675+00:00",
"db_currency_id": "c65beb40-aceb-40fe-9c3c-488922a2fa88",
"db_currency_code": "sample string 10"
},
"company_type_id": "fe652145-738d-4656-8e11-eb94df23b834",
"company_type_name": "sample string 32",
"company_type": {
"id": "5d9d6afc-02f5-4099-88e5-0afbd6ac9dca",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bbcc5188-3990-4a01-a9fe-5bf5866a0f7e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "25035f5a-4d88-4df3-ac51-602a2771c618",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e4afb68b-48c7-426a-b2db-ab097c44a802",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "77dcb561-9fa5-4e24-8f1b-5d4722e10a82",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4d9c245d-201d-40ad-abf9-356d24b3782e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-13T18:44:27.3107675+00:00"
},
"company_sector_id": "022da79e-3a73-4cc3-bafe-77f96f525152",
"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": "75c34110-83fb-43c1-a39a-71a31276cbf1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bb25320a-075f-43b0-9b24-9774d8fb6c3f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3218f471-f8f1-411a-9ba4-775b32812982",
"account_manager_user_code": "sample string 56",
"company_status_id": "bb073bb9-7543-4f8c-8375-dba347f589de",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-13T18:44:27.3107675+00:00",
"id2": 60
},
"db_language_id": "30c1238c-d8e5-412f-9db2-d788a191702e",
"db_language_code": "sample string 7",
"db_title_id": "3a3cc28a-bf72-4dec-a4bf-e93ec1e8114e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-13T18:44:27.3107675+00:00",
"create_date": "2026-11-13T18:44:27.3107675+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-11-13T18:44:27.3107675+00:00"
}