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": "4f51b350-7e11-43cd-82cd-d00f53097f58",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "05a9ccf6-3de4-4787-be40-dd6970b2d95f",
"company_code": "sample string 5",
"company": {
"id": "503ad851-7521-4afd-b5bd-a42bd2c84cd7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-09T06:31:54.8356606+00:00",
"sales_territory_id": "a8c65c45-0065-4e15-8ca2-57105ea9101a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c984c242-dacb-4e59-9430-d4c7276c4d7e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "483da083-b30f-42f2-a195-4034ddc0e17b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "22ab8c91-55bc-40ac-b75d-c14d410f61ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "62917416-28c7-47e5-bfce-cb95cd6524ff",
"db_currency_id": "e8b61580-aac1-4a9d-9c4e-1614c1dc3a6a",
"db_language_id": "d2ebd1d3-3ec1-4cc8-bd99-ffac31422cfd",
"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-01-09T06:31:54.8356606+00:00"
},
"modified_dateutc": "2026-01-09T06:31:54.8356606+00:00"
},
"marketing_segment_id": "9d1810e8-4bc5-413d-9128-f7a8240ff9fa",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "148c5c3b-15db-43a0-9bc4-611b8c60d4f1",
"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": "e31cc7ba-be45-4d7a-b1d7-a4414ad2a587",
"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": "da196e17-b265-498e-b43f-e2907094b38f",
"db_country_code": "sample string 28",
"feelist_id": "cdbb29ff-2a76-4f5c-9f3c-490bd7caf230",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ad914ce3-824a-4155-a0f1-45a85956f0f7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0c7a8e40-7498-4e2b-834f-a216abdc4965",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-09T06:31:54.8512836+00:00",
"db_currency_id": "6d3b7ee9-56c9-4461-ac03-604dd965f600",
"db_currency_code": "sample string 10"
},
"company_type_id": "f9ddff4e-410c-4f91-a6b6-df186ed27601",
"company_type_name": "sample string 32",
"company_type": {
"id": "1e3f2c4b-d086-4816-8b04-f2dc57db158c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a17feb7a-761c-4818-a9e8-6d95a4c163cd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "430a4fcb-9afa-4e9f-b2c4-b6342b1a9540",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "952872b9-6802-436a-b22d-19333aebcad4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fcbcf0ea-f43f-438e-9e4c-a3bfdb30be41",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c7324d07-32c8-45df-a2ec-51c40791a5ed",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-09T06:31:54.8512836+00:00"
},
"company_sector_id": "36ed281c-0b4b-4968-9720-411d3f511f42",
"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": "ca9b376c-1810-40f9-85df-e0a57b42ee6c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f731b228-c9ea-4598-b3fe-115d7b4a5294",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c5552bbc-73a4-49aa-af4f-9117f1e6ba57",
"account_manager_user_code": "sample string 56",
"company_status_id": "88e78032-b2a9-4206-bc8d-f4c0828d9f2b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-09T06:31:54.8512836+00:00",
"id2": 60
},
"db_language_id": "67c29d9d-c5fb-4a60-85ad-6d9d2a397326",
"db_language_code": "sample string 7",
"db_title_id": "dae777fb-c99c-46ea-8120-aea304a1f23b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-09T06:31:54.8512836+00:00",
"create_date": "2026-01-09T06:31:54.8512836+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-01-09T06:31:54.8512836+00:00"
}