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": "0b8a6015-e21d-4717-b17c-127bcb25bb75",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d28e909f-23d9-4052-b69c-433b9c1d2629",
"company_code": "sample string 5",
"company": {
"id": "38ff286a-b4dc-40db-a368-4e82814ed201",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-14T06:26:22.4994396+00:00",
"sales_territory_id": "7c059c20-df68-4900-8e28-99a11e369b21",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3441ea9e-a374-4a89-86a0-9c98f52d8f19",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "65cec944-577d-4166-9418-bde48ab467d8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "319c8e76-286d-4b42-b3d9-646af5af7eca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "849aa434-8d89-4650-baae-b7bb211e28e2",
"db_currency_id": "0f93c069-5eff-488f-87ef-d4161af47a35",
"db_language_id": "da0445de-8332-4e3f-9288-a34e9056566d",
"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-14T06:26:22.4994396+00:00"
},
"modified_dateutc": "2026-02-14T06:26:22.4994396+00:00"
},
"marketing_segment_id": "4cbb68df-5a05-4ba2-9ad9-74b057088fd6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0d57234b-f5c1-4447-81e3-33364628c0b8",
"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": "91635dc5-ea88-4c6c-9098-d9bf44d88311",
"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": "f6544d71-10c5-4b17-b355-6e55e09ec775",
"db_country_code": "sample string 28",
"feelist_id": "27850296-22c2-4b33-9fb8-c7b5a106a2de",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8784f0e2-2f52-4032-af70-74b72579065d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fac02b39-79c8-46e6-978d-f52459fa3bf6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-14T06:26:22.4994396+00:00",
"db_currency_id": "a1c7d33d-d4da-48b3-b273-8bbafad1f67d",
"db_currency_code": "sample string 10"
},
"company_type_id": "46fc2e7e-70f1-4e71-aea5-050ab6b7f4c5",
"company_type_name": "sample string 32",
"company_type": {
"id": "55500f36-089e-4756-a5b9-893f3b16aa86",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5ea12c45-6109-4a71-b6e5-8514f9fa0620",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5bfa18aa-860c-404f-a9cd-75e9248c34c8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e6aef42c-8b5a-475f-b517-ced28256663c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ea9d903c-9e77-4354-b71b-11faa79dbed8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "386dfe47-64d4-4a98-bc37-5336809225f5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-14T06:26:22.4994396+00:00"
},
"company_sector_id": "11b6151e-bba6-4613-8bdf-3e2cc078e63d",
"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": "b17fb27a-aab8-4c06-a82a-e14280c72932",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a3250e50-5bc2-4cad-a8ab-dd58204939ef",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c81ea41c-bdd7-47a7-8ef8-b7ead7e53792",
"account_manager_user_code": "sample string 56",
"company_status_id": "7cb5a115-de48-459b-9d48-f424b70e6e3a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-14T06:26:22.4994396+00:00",
"id2": 60
},
"db_language_id": "163d8be0-1c3b-492b-b027-399ec1a55a2e",
"db_language_code": "sample string 7",
"db_title_id": "7c576a7b-5357-4612-a97b-a404065dd2de",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-14T06:26:22.4994396+00:00",
"create_date": "2026-02-14T06:26:22.4994396+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-14T06:26:22.4994396+00:00"
}