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": "c04d2f10-cff3-4aee-957b-45dd93a48dce",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "955765ec-2d07-4eb8-8567-41cc6d85d991",
"company_code": "sample string 5",
"company": {
"id": "4a4e7a56-0bef-4039-a4a7-b3c557df0212",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-20T03:21:42.7190587+00:00",
"sales_territory_id": "30698f1d-9bfb-4f00-8a53-b45dd6a1fbd0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8b0f0716-4a47-46b9-b01d-951e90554ba3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5668df1f-f3d5-4323-bb9b-4b6c5a72a315",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c7da51c2-f1bd-461c-8669-d422145aad1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c3e5871f-9bd7-4c44-bc9f-5b769994534e",
"db_currency_id": "bde5a162-1544-4c47-92c9-b09589f5338e",
"db_language_id": "177fe8d2-7ec9-4081-b1b9-4ad73f768ed2",
"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": "2025-12-20T03:21:42.7190587+00:00"
},
"modified_dateutc": "2025-12-20T03:21:42.7190587+00:00"
},
"marketing_segment_id": "b10c586d-c901-4742-a91e-ab99256e6e4c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "20bd10e4-b4be-43e0-a272-3b05d2ebef5c",
"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": "025207d8-cd5c-4911-a0fd-8507e85627ea",
"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": "319feda7-aa03-49c1-9e86-41288dd07eea",
"db_country_code": "sample string 28",
"feelist_id": "6e78204a-caa6-4e99-869a-b7915bce46c2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "82df6a90-cf21-4a67-b76b-80af7ea7e85f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "83218135-adbf-4c96-955b-c06a60bea331",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-20T03:21:42.7190587+00:00",
"db_currency_id": "11a8dc65-5fef-491b-b566-02a7a2d200c3",
"db_currency_code": "sample string 10"
},
"company_type_id": "845381be-b916-4e37-b3dd-ea78ee0c11e2",
"company_type_name": "sample string 32",
"company_type": {
"id": "26f15311-6398-48a1-b4f1-2a43449c95e7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f7bdab46-0494-4ab1-bc82-2c13c35e114f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c8e7d611-1cf0-44cb-9df0-cfaa72e3cb66",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "701a295d-3e6d-4c88-8b39-0afc28fd6be9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5a7f55c6-1dc5-4953-93c0-0ce2defd8736",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "08f68690-a4a4-4f26-a371-e886425b8161",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-20T03:21:42.7190587+00:00"
},
"company_sector_id": "aad2d62e-d0f9-4198-869d-f6b7352996fd",
"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": "cb12a30b-b5e4-49a3-b18b-e523767beb9a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b6d51e0d-7dbb-4976-8bc1-3b1d207e1e0c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e058f0d8-f2c7-4934-b2b2-729eabff8f1c",
"account_manager_user_code": "sample string 56",
"company_status_id": "01f84385-0be3-47ee-9534-d0d7731ddabd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-20T03:21:42.7190587+00:00",
"id2": 60
},
"db_language_id": "0ec207f6-a8d7-4e13-80b1-416055be6e23",
"db_language_code": "sample string 7",
"db_title_id": "4717135c-c9b6-4b82-b06f-1fbe9d51d4b7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-20T03:21:42.7190587+00:00",
"create_date": "2025-12-20T03:21:42.7190587+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": "2025-12-20T03:21:42.7190587+00:00"
}