Retrieves the company 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": "596b0a0d-3229-4b2a-969f-f304496f9f9e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b42752f3-c927-490d-8162-08b5d432c09a",
"company_code": "sample string 5",
"company": {
"id": "84a34b61-b5f3-4c44-a118-cab0bf971f71",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-21T23:03:51.2319602+00:00",
"sales_territory_id": "105cf744-e693-4c3d-89ea-e8330fbb8de7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b55ca2ac-c96a-4682-83d5-88384f36f79e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "75dd6c93-363e-4437-8a63-780e71f7c67b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "52bb3807-54aa-48c3-9b65-de940bfca867",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "abd6221c-0c1a-480e-88f7-04d3f61820d4",
"db_currency_id": "121b4172-418d-4d2e-be4d-f5b66d8b03f9",
"db_language_id": "3bb18956-ec10-4d94-982b-b8fc613872e5",
"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-09-21T23:03:51.2319602+00:00"
},
"modified_dateutc": "2026-09-21T23:03:51.2319602+00:00"
},
"marketing_segment_id": "121fafb9-e40e-45ed-9c54-88d73d340107",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "df18d5fc-0948-4edc-ac32-4be3a57dea73",
"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": "fc52a867-eff2-4bc2-b011-16f5c8bb1c46",
"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": "040ffc2b-df5a-48f7-9c37-8ee37426de22",
"db_country_code": "sample string 28",
"feelist_id": "f35cefb4-aee1-4887-9b7e-b7936e675e8d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "95bd87c5-41b2-4620-86b8-673cb24fa39a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "09868460-b125-43f3-a5b1-10f73e47c1a6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-21T23:03:51.2319602+00:00",
"db_currency_id": "157c1114-f386-47d5-80d0-daeffea3b8f8",
"db_currency_code": "sample string 10"
},
"company_type_id": "c9ccc714-0d0a-45f7-bdf2-164c5181b7ac",
"company_type_name": "sample string 32",
"company_type": {
"id": "8c792b96-b565-4ca0-a1fd-393bc3c497d2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "11acfbc0-7015-4cb2-b22c-9df3401a0091",
"sales_organization_code": "sample string 5"
},
"db_language_id": "16dd2adb-336a-405d-827c-65e170cc82d3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "47fbc470-f912-406f-a6cd-959fd890c8f2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1f7cad77-1f23-42a0-af07-cf8c3da80e0f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0447dec7-2721-4c69-941c-0c6db26287e4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-21T23:03:51.2319602+00:00"
},
"company_sector_id": "0a135839-bf9c-4e84-9531-17054a0ebb51",
"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": "38025911-508b-4553-9697-86e2722af025",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3aaecda3-98b9-488c-8763-c17c06c55046",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a9c9c6d7-a603-4977-b2e4-9495f310f3bd",
"account_manager_user_code": "sample string 56",
"company_status_id": "b356f2ea-1b2d-4b9a-92f8-fd9d2f83d280",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-21T23:03:51.2319602+00:00",
"id2": 60
},
"db_language_id": "6734f0c1-4044-4b81-82c5-417d1930516a",
"db_language_code": "sample string 7",
"db_title_id": "226ea80e-1cbb-4886-926b-717f013d205f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-21T23:03:51.2319602+00:00",
"create_date": "2026-09-21T23:03:51.2319602+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-09-21T23:03:51.2319602+00:00"
}