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": "0c56915f-1d62-4e32-8f22-64705082cb0b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9b339dca-341c-4c42-a7af-6c3c9ed603c7",
"company_code": "sample string 5",
"company": {
"id": "82d4abf6-c61f-408d-9954-9972587a5c4b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-17T06:12:08.7197291+00:00",
"sales_territory_id": "a5d4a443-2d56-42f6-beff-f0a6ec563e56",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a0c65a62-485e-4fc3-9e1b-ea96a015b86a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c6602a1c-d646-4ca7-9bbc-7866b99a5d2d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8bafafec-b16a-4cab-8e19-67299e324e09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "870d6860-f962-4e7b-8502-8475f2836531",
"db_currency_id": "4c703425-ad19-4ac8-bdb2-68b551fc55e9",
"db_language_id": "536919bc-1c04-452c-afea-a075012e29f4",
"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-09-17T06:12:08.7197291+00:00"
},
"modified_dateutc": "2025-09-17T06:12:08.7197291+00:00"
},
"marketing_segment_id": "e9069e3e-7f3f-4003-aa2e-cd1eeee23bcb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "12742433-98d7-4d68-9273-c69cfa26210b",
"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": "f6e4a456-5bdd-4641-8c54-2e09a1d8e852",
"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": "f7950e1a-928a-4dab-862b-39b56dacdb9c",
"db_country_code": "sample string 28",
"feelist_id": "5bfa0a7b-b93e-4774-912d-b4ca15b33524",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ecfd0454-c93a-4078-a78d-dd73ad548772",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8430db7c-5c60-4a9e-a86c-bddde37f4b3b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-17T06:12:08.7197291+00:00",
"db_currency_id": "a38d2ba2-0637-44e4-bc3f-28a6fa364652",
"db_currency_code": "sample string 10"
},
"company_type_id": "dcf88988-b855-473e-93f0-288a22fa2afa",
"company_type_name": "sample string 32",
"company_type": {
"id": "c62af8b9-b57e-4637-bcf6-b344d0f0553b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cf2488e8-b53e-4818-9261-ad410904d7f2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1b40b8d3-e1e4-41c2-9b80-c81f710a6522",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "62cbbeb7-01ee-454d-b3bd-9aff8eb0ad68",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5b40cc5f-4e26-4e09-ae7f-0a045ead6dfb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b67cf384-9d18-41ac-97ce-ebb2e914f87a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-17T06:12:08.7197291+00:00"
},
"company_sector_id": "df862042-73a8-413d-94a8-cf55a50e5d29",
"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": "8c7b45ee-eda4-447e-afc4-f41b4b9844de",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "086b892f-8767-49d4-b253-b96c42d7824d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "72a734ae-8fcc-4a50-b490-6731fa21bc14",
"account_manager_user_code": "sample string 56",
"company_status_id": "41c32549-cd89-4c94-ba45-9dab0c84dd00",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-17T06:12:08.7197291+00:00",
"id2": 60
},
"db_language_id": "50b38f2a-6303-480d-9e01-d82d0bf185e2",
"db_language_code": "sample string 7",
"db_title_id": "58c46203-e05c-4599-846f-5d4f7ca2deb7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-17T06:12:08.7197291+00:00",
"create_date": "2025-09-17T06:12:08.7197291+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-09-17T06:12:08.7197291+00:00"
}