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
{
"id": "c346057f-c738-45dc-a2fa-4c557b1630a2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9e8012c6-a545-41a9-a89f-dca469ad24f7",
"company_code": "sample string 5",
"company": {
"id": "a3fa9182-36c4-4178-823d-36f63b29bfa1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-17T06:16:47.026214+00:00",
"sales_territory_id": "f221b699-a34b-405f-bd1e-ce7f75db51ef",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "72fddabf-adf0-45af-9840-9dd40c8140d6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "61237dd4-92df-4605-9fab-ed97452a2d69",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b3ef382f-1031-4122-9439-7d99e702258c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88703718-9efd-4065-a723-d1053f2c0200",
"db_currency_id": "634eaf6e-db02-4c0a-afcd-e9ef37356db3",
"db_language_id": "55c65fa3-39e4-403c-b0d3-0c4edbd1b030",
"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-11-17T06:16:47.0399344+00:00"
},
"modified_dateutc": "2026-11-17T06:16:47.0399344+00:00"
},
"marketing_segment_id": "f44cd26a-5c09-499a-bd54-c1ed4314777e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1d731d81-68ff-4fff-aa1d-c9c5c714e6e0",
"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": "52a275dd-53ab-4857-a529-18178b097253",
"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": "f32503e5-eab4-4296-8fed-c9c56a87ebaa",
"db_country_code": "sample string 28",
"feelist_id": "34e7a9a5-bc9e-4c21-9fee-be997bd6d621",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b28f3746-4759-479e-a034-203f698fc216",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7b9d80b4-be65-43a9-a1c3-10e83ead3814",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-17T06:16:47.0399344+00:00",
"db_currency_id": "6c7ea806-2157-4650-be22-1ad4429bb045",
"db_currency_code": "sample string 10"
},
"company_type_id": "06fdb247-5944-401c-914d-87898e07a3c3",
"company_type_name": "sample string 32",
"company_type": {
"id": "9f96f30f-b917-4300-8269-d696d240e4e0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f36c01a1-4a04-47c9-80c0-fbea84f5fa26",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c6077cdc-46bf-4cfa-ad7d-b3c2511be734",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "12fc0d16-7b75-440d-8089-5e0daf089104",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b2531fd4-322a-4e87-9cb6-c2ebf8fe20d4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4586296f-4d3e-4e1e-9338-ea3db84aee20",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-17T06:16:47.0399344+00:00"
},
"company_sector_id": "2c7d118c-de5e-4ee3-a396-fedf17543660",
"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": "35cee97c-0e1d-47cd-b303-064ad180b4b8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "213a6e85-80dc-47c5-8718-aa36ee5cfd39",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "16bf31c2-59b5-4adc-b3c3-e88a2ff1df2e",
"account_manager_user_code": "sample string 56",
"company_status_id": "86bf58ef-c967-469a-b47b-96882d803699",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-17T06:16:47.0399344+00:00",
"id2": 60
},
"db_language_id": "331718ac-675e-4c14-ae9a-593ac52a7150",
"db_language_code": "sample string 7",
"db_title_id": "9d06afb8-b661-4739-80cd-511d850dd30e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-17T06:16:47.0399344+00:00",
"create_date": "2026-11-17T06:16:47.0399344+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-11-17T06:16:47.0399344+00:00"
}