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": "33e9eb76-4e72-4e43-ab50-c3bdb7312902",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "16ffaf4e-113f-4b30-b62a-d2f33fe2ad79",
"company_code": "sample string 5",
"company": {
"id": "4c8bb848-9d05-4e8a-822b-9895410ae73b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-09T22:49:26.0539279+00:00",
"sales_territory_id": "37236d89-ac0b-448f-a656-1ecc1780f296",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "913efd40-4c43-472a-a9f5-15caf4e47e09",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "23485bfc-a1f8-4b4a-8e01-bfee5145dca6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "694417a4-b048-4c31-b179-d737b7593ef7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1c0a4c9-1452-42c0-bfc4-055b941d5f42",
"db_currency_id": "fdc7e3f0-08f5-4cdb-ab94-7417fbac6dfc",
"db_language_id": "0d864527-d4e0-4c62-8e86-8a23bf5e580f",
"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-02-09T22:49:26.0695561+00:00"
},
"modified_dateutc": "2026-02-09T22:49:26.0695561+00:00"
},
"marketing_segment_id": "f8fa1f0f-b5a4-4452-81cf-12c48d51b7ee",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "00eeee61-06ab-4d95-991f-9d546071fb69",
"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": "f211812f-3cf9-450e-a543-035a8ad86e4c",
"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": "b50b4014-136c-4760-b529-b1fa9f2c7887",
"db_country_code": "sample string 28",
"feelist_id": "88d21435-32d6-4f7d-819e-c8f6555f9d41",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "27fa549d-050c-45e3-8ec4-fcc4eec51574",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "29795571-1915-465a-b43a-f586c54071bd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-09T22:49:26.0695561+00:00",
"db_currency_id": "c7e2edc4-2fa7-448f-9354-74e819e00862",
"db_currency_code": "sample string 10"
},
"company_type_id": "a754434d-bf59-41c5-8430-515eaddd67da",
"company_type_name": "sample string 32",
"company_type": {
"id": "c15e2795-3f22-41d6-b6cb-689995e6d657",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "91641599-cb7f-4e27-ae86-9462e8717d49",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d7110392-b929-4804-9b64-b3670967990d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e862baca-531e-42b4-9af5-fd185ded04e4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3debc830-af44-480e-b84b-68ba0a18cf1a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "db6a2315-4d9c-43af-8dee-c296aadbc721",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-09T22:49:26.0695561+00:00"
},
"company_sector_id": "9b649c21-dcf2-45de-ab72-e835f204bfd4",
"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": "c605a3a4-187c-4c4d-b92b-f1203c6b6ac0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7b7c3aae-60db-4dd8-9d65-0c51e1d1b9d7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b7b00410-b7cd-43f6-bc74-df114cad1661",
"account_manager_user_code": "sample string 56",
"company_status_id": "9c17c238-3d64-49bc-9234-0bda95c53966",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-09T22:49:26.0695561+00:00",
"id2": 60
},
"db_language_id": "fa221793-809c-49e2-9400-43eb0af32703",
"db_language_code": "sample string 7",
"db_title_id": "7bd757b9-1c5a-4e9d-b40f-dce2b200c2c4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-09T22:49:26.0695561+00:00",
"create_date": "2026-02-09T22:49:26.0695561+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-02-09T22:49:26.0695561+00:00"
}