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": "84d75ca5-03f2-4e64-8f22-e5fef5102b2e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bae50c94-b848-44c3-9daa-21b73bb9fb03",
"company_code": "sample string 5",
"company": {
"id": "64f8c714-a347-496b-8224-03f01ee093ca",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-17T22:20:00.0528162+00:00",
"sales_territory_id": "37977649-08c8-4b86-9467-9d3461982d3e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ee79bf15-dfcb-45af-ad9c-b886a5bbf8a0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f829afe9-7612-490e-af4c-315863093595",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4f13d5dc-34c7-4c4f-8759-97b61bff1a38",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0bbe66d3-ccea-4771-a554-ff770d6338fd",
"db_currency_id": "751c3e89-67e9-4ee2-8bb2-868d8c582a28",
"db_language_id": "d84b972c-5aa4-4ea3-a3ff-44b80c12c5a6",
"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": "2025-11-17T22:20:00.0528162+00:00"
},
"modified_dateutc": "2025-11-17T22:20:00.0528162+00:00"
},
"marketing_segment_id": "4d5182b8-afd0-4d60-9c47-530f8df8640f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "112387e9-4390-4f50-9841-aee9496f8699",
"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": "101f75f9-2e91-486c-87cd-14b296406df4",
"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": "4a88d3c3-1e0f-4b51-8bad-ff6f0137f11d",
"db_country_code": "sample string 28",
"feelist_id": "6262e994-3651-4670-8e43-8f14072c4fd2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b03a4ef3-ba15-4f59-ae43-9bc711a4fbc2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4b7e0a78-34e2-4e7d-bda0-d01224316363",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-17T22:20:00.0528162+00:00",
"db_currency_id": "820cf1dc-2fb6-434f-b415-6ed90e85ccde",
"db_currency_code": "sample string 10"
},
"company_type_id": "e0f9b67d-23fe-42c6-99e1-ac64a21aac3e",
"company_type_name": "sample string 32",
"company_type": {
"id": "ba557a2c-4094-4eb3-913e-62e03a1189ab",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9a920f4d-6180-4e87-a014-a25de532fa1c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e7ddcb90-db93-4b29-a603-c58f3caa42e1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e1ccea79-2bfb-4bf3-8b95-3233d69f623f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a5d547b0-9f0d-4e63-b04c-71243c462d0a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8862b1ec-4bb3-4781-ac03-99afcfb45b06",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-17T22:20:00.0528162+00:00"
},
"company_sector_id": "a6d9c494-5dc9-497d-8a79-9867d17c3006",
"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": "5167adf7-65cc-4d13-8dd2-9a2014d14c08",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5a755961-ce94-4e6d-9e46-c10d3d5547ae",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "deb3a749-630a-46c1-bcd4-4adb55759c96",
"account_manager_user_code": "sample string 56",
"company_status_id": "d1a0875a-407e-4014-a8ac-0df05457db2d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-17T22:20:00.0528162+00:00",
"id2": 60
},
"db_language_id": "ed2bd30c-16a6-4d47-a364-3e117c60e6ad",
"db_language_code": "sample string 7",
"db_title_id": "9ec7d5ca-abc7-4edc-a07d-e505ca8b697a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-17T22:20:00.0528162+00:00",
"create_date": "2025-11-17T22:20:00.0528162+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": "2025-11-17T22:20:00.0528162+00:00"
}