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": "6a099ae1-cce1-4fa0-83ac-1b0b502bef56",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "afc00830-183e-4d79-94fe-71413e1c6d11",
"company_code": "sample string 5",
"company": {
"id": "b84cfdf2-fe20-40b1-b62a-df1a2960a809",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-14T04:28:59.572351+00:00",
"sales_territory_id": "8a4186b4-bc3f-4534-9765-fa81b98126bf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "56558176-52e7-451d-9a59-52103a44d60c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "14f633a2-13e0-4fc8-8202-d2e9b1c3051d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ca264acc-ae37-4f78-a91e-20cc4802a475",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b8a452b-ef0e-44a5-b8c0-7a7b7ff05cf1",
"db_currency_id": "6e2f0ae1-bac3-46a6-a228-3c56cbb4b4aa",
"db_language_id": "cc7ddd6e-88fc-4c87-88b0-496766711353",
"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-14T04:28:59.572351+00:00"
},
"modified_dateutc": "2026-08-14T04:28:59.572351+00:00"
},
"marketing_segment_id": "d4be04b8-dedb-4f34-a53f-26769c8de956",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4d8b9b1d-65de-4452-9664-eb01d98a52a8",
"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": "86d80d97-7b58-4512-93e9-b2998245e9af",
"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": "8ea2273e-649a-43f9-b57e-28a5ecb0cb25",
"db_country_code": "sample string 28",
"feelist_id": "8d944407-d296-41a8-b6bb-76ff5926db89",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "81f8623b-4b4b-4446-b085-8d4571adf795",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a1ed3163-bbad-4637-a138-4f7557ca6342",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-14T04:28:59.572351+00:00",
"db_currency_id": "9ae9a93c-9e21-4d22-af8b-6d7f3effb605",
"db_currency_code": "sample string 10"
},
"company_type_id": "d502af25-b3b4-4ec0-8d0a-832588164880",
"company_type_name": "sample string 32",
"company_type": {
"id": "07f3650f-62ea-463d-b286-2cf73cbaa855",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "16016873-7a9c-4f4e-ab1a-dfb1504a19c9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "eba0adde-1b3b-4b48-97ba-60e098cd730e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cf2cca4f-1f36-4e58-8678-3298a8b0e87e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "489702b9-ff4e-4902-8044-0ad320cc7c38",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0d5406fc-5484-4006-9728-54f0dec58e68",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-14T04:28:59.572351+00:00"
},
"company_sector_id": "2340c5fe-58a9-4ca6-8c94-2ab6ac95d43c",
"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": "6fb7da98-39cf-4a87-b9cf-ae4bb7705b8e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "393b52b7-5d72-4f14-9782-a35d6b898eb1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ac170c4c-7421-4c8e-beec-ac55c2f36c4e",
"account_manager_user_code": "sample string 56",
"company_status_id": "2ac4ce6b-04ae-4adf-81a5-c356a3f0f5f9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-14T04:28:59.572351+00:00",
"id2": 60
},
"db_language_id": "ba08e9fc-a734-4124-a360-03852f3bad72",
"db_language_code": "sample string 7",
"db_title_id": "be3b0721-ee84-4f01-af03-43fbbadb476f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-14T04:28:59.572351+00:00",
"create_date": "2026-08-14T04:28:59.572351+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-14T04:28:59.572351+00:00"
}