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": "8dbc1e9d-b309-4f12-a276-16fd9cf3d4d4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "26092994-14c0-48ae-9ecb-4787621b520f",
"company_code": "sample string 5",
"company": {
"id": "d5b6bfee-539d-4165-83fa-fd01cf96ff84",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-08T08:38:17.5233047+00:00",
"sales_territory_id": "408d5bf9-6b7e-4ccb-bd62-408532230e56",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "00682173-1491-436f-b0e8-8c4aedf64b85",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bf3de355-d4e5-4f2f-b45e-8e7a77b9f7d3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "542bfffa-559d-4cbd-b7ba-69e88a34a53e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08446197-d6e8-455a-8d0d-1ca49e355ebd",
"db_currency_id": "e0636f75-1fb7-4ea5-9958-b168555084ce",
"db_language_id": "ee1ef354-3d51-4fac-b42a-ab31e33d1fb2",
"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-03-08T08:38:17.5233047+00:00"
},
"modified_dateutc": "2026-03-08T08:38:17.5233047+00:00"
},
"marketing_segment_id": "9b76fbb1-d6b7-42c2-b2b9-4fb34c7db638",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c768c974-2f60-44df-9079-f3c6000f41fa",
"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": "687f894f-aaff-476a-9c31-d3587b8b8c59",
"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": "316f257d-4a6c-42f8-af26-b0666f386fa2",
"db_country_code": "sample string 28",
"feelist_id": "8605ec7e-decb-454c-a778-ced6dd4273da",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d6ad3d7f-c29f-437f-a2b7-9d7050feee3d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "49da5f26-74fe-42f7-bf52-c28db40117fa",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-08T08:38:17.5233047+00:00",
"db_currency_id": "350e47d9-48e8-4747-b7bb-d6bbc21dca72",
"db_currency_code": "sample string 10"
},
"company_type_id": "3b4325f8-f7b7-4dc5-92a6-2ed08cc3c64f",
"company_type_name": "sample string 32",
"company_type": {
"id": "2d9720c1-8107-428b-846a-cfadf24fcfd8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "145a818e-1528-4635-8283-6b150f981a46",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8c8bec89-f18b-4c9c-8527-95ad235ae282",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f6b71cfa-913c-433b-a4ad-0d481035453d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "85571f77-18a1-405d-9192-b3cfed2b324c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "142e0caf-555d-46dd-99fc-98312f8c9894",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-08T08:38:17.5233047+00:00"
},
"company_sector_id": "b3257f2b-58a7-48b0-b35b-d843eb1a45c2",
"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": "fc770f03-e478-42bb-8df7-9b541139a28f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "49cd3587-29cb-404d-a985-be523ef6d84c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2c07af02-45c0-4107-ad45-8090d2d08c19",
"account_manager_user_code": "sample string 56",
"company_status_id": "a407a592-c50d-40d8-9349-d89cbb92a3b0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-08T08:38:17.5233047+00:00",
"id2": 60
},
"db_language_id": "96fb0266-ead5-4418-8041-e97a83753f24",
"db_language_code": "sample string 7",
"db_title_id": "1db9cc72-c0d1-4b56-86ef-d196ea81cf29",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-08T08:38:17.5233047+00:00",
"create_date": "2026-03-08T08:38:17.5233047+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-03-08T08:38:17.5233047+00:00"
}