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": "be9c0c77-df7b-4be1-b649-898d257f1c7a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "39e6e693-fe3c-4c6e-8e6f-57f5fae4f3e1",
"company_code": "sample string 5",
"company": {
"id": "c51b84a7-ce25-4d6b-a343-180644d5e6bc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-18T03:28:57.1423488+00:00",
"sales_territory_id": "156018a5-614c-438c-bbc6-cf9259666aac",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d0e3ed2b-611a-44b6-b4d2-b0fa51a80d9b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ef434b65-5e9b-4889-ae0f-a27bbe7530c9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "42c0c808-8912-493f-ba1c-156e046506af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9854a91-3911-4e11-95e5-c312df29ad59",
"db_currency_id": "715f5632-b2f2-4ce7-88c2-c2fc7b482d74",
"db_language_id": "80c5bc4c-3cc2-4805-ba9e-c5065e7fe1d5",
"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-05-18T03:28:57.1579443+00:00"
},
"modified_dateutc": "2026-05-18T03:28:57.1579443+00:00"
},
"marketing_segment_id": "d4e2e4ca-6919-49f9-a0ba-8c939c8fd27e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a2039300-4c35-40a2-ac1e-3b80077f248a",
"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": "608ef220-6b8e-46c9-a2c3-be8b1bdb0967",
"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": "5849b7df-6476-4ccd-bddc-ea84c4c4c218",
"db_country_code": "sample string 28",
"feelist_id": "50b3617e-1b68-45ca-a36f-0a0414cd45a2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6e7c9cd9-7224-46d9-b9bc-f3d5f003c450",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cace715d-6335-426b-ab3a-565d3b4965bd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-18T03:28:57.1579443+00:00",
"db_currency_id": "47f272a0-70f1-4ad0-b6cf-8980a0b68c8a",
"db_currency_code": "sample string 10"
},
"company_type_id": "4dfc2732-5d4c-4f3b-9e6c-91bdd83b121e",
"company_type_name": "sample string 32",
"company_type": {
"id": "48518bc4-d0f6-4d1a-a55b-33702a2bdc5b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e16557cc-076c-4516-90fc-1dfffae7e565",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a4a7bc6a-5b30-480f-996f-c13baa28afbb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8cd20907-69cd-486d-ac56-7618db416cde",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "750b316a-04ed-416f-b3c9-924051fde8c3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "03fcff85-8554-4f90-b36d-e89a5e68621e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-18T03:28:57.1579443+00:00"
},
"company_sector_id": "ab0a6968-c72b-4093-b1c9-06f1df212254",
"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": "236f358b-8682-4e71-bb44-6d01a489c95b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1ca7a335-a905-4071-964a-b68aab8ce813",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "60a82b13-c492-4c2d-9029-67b4baa6fa44",
"account_manager_user_code": "sample string 56",
"company_status_id": "38b92809-9a70-4dad-8280-25f551443b58",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-18T03:28:57.1579443+00:00",
"id2": 60
},
"db_language_id": "52c682a4-1c35-42d8-9e31-b031a66e3714",
"db_language_code": "sample string 7",
"db_title_id": "c8cd8bc2-75f2-4d2d-b352-51ac7621b525",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-18T03:28:57.1579443+00:00",
"create_date": "2026-05-18T03:28:57.1579443+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-05-18T03:28:57.1579443+00:00"
}