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": "70754caa-aa29-41ec-bc0d-a250a9a188c5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "70273f09-0d7b-4c51-ac20-d199b3ce7330",
"company_code": "sample string 5",
"company": {
"id": "c1643dab-ad8e-46f5-8821-bab05ea81967",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-13T22:21:16.027111+00:00",
"sales_territory_id": "424a31da-1739-4153-bcc6-1e8d23c5b2a5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6e189673-c997-4f5d-9ee9-5fbfb0a9b77e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d525c34e-c268-489b-8973-d71e2ebd5b2a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "af04e3be-2c19-4b5f-bb51-485302eef8e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81952b7c-1cc6-4771-9d88-adcdcf133e1a",
"db_currency_id": "905735cd-7b35-4610-9650-47be3253ee95",
"db_language_id": "cccc03a4-ce97-47f5-95f8-c8fc7fc0a498",
"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-13T22:21:16.027111+00:00"
},
"modified_dateutc": "2026-01-13T22:21:16.027111+00:00"
},
"marketing_segment_id": "91e94374-7315-417b-ba68-ad4c49f28cfe",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "813a1de7-14f5-4a79-b900-72780e8ea1b4",
"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": "b508e8ec-55f7-44d3-9708-341e33a7f7c1",
"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": "cb65de67-6b3a-493f-9553-52b9aa721e27",
"db_country_code": "sample string 28",
"feelist_id": "7f79d0b7-ff0b-4e64-9db7-07ea11e46018",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2b615a03-5b1c-4eb5-a993-c38e08e47cd5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2b48564a-9270-4bec-814f-fa6ce2d76a21",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-13T22:21:16.027111+00:00",
"db_currency_id": "f82aa41a-ad75-402d-966c-bbc59b479e59",
"db_currency_code": "sample string 10"
},
"company_type_id": "b614a3b3-6bf2-4cc3-aee0-d6e09b4f1849",
"company_type_name": "sample string 32",
"company_type": {
"id": "8f9a1559-5c02-421a-9381-df13ab6cbfc5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "44f721d2-6bac-4134-b9b8-c573f9793393",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3a576f1f-2af1-4745-b136-a0ad31d2b110",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3186b25c-2e6a-4e62-8580-3c61e262fdd3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "50c298d9-7e0f-49bf-ac5e-064a76d5b358",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0ab9cd87-7e17-413f-a854-832cb0e93f12",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-13T22:21:16.027111+00:00"
},
"company_sector_id": "e699cac5-d814-48e5-8b14-a7ab95e63a8f",
"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": "678825ff-ce84-449c-832d-5d1f70b9079c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5ac5e4db-cf28-41fd-a15f-ef0254d8d909",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "03265f82-a3c8-4c87-b862-9a0b9c6f5e1a",
"account_manager_user_code": "sample string 56",
"company_status_id": "ed39f53b-1956-43e4-b7d8-98e1ea81246b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-13T22:21:16.027111+00:00",
"id2": 60
},
"db_language_id": "8e51c5be-af2b-4561-9cfd-df1d5a953ad0",
"db_language_code": "sample string 7",
"db_title_id": "17c89dbb-383e-4f1e-8ad3-99cb29175b66",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-13T22:21:16.027111+00:00",
"create_date": "2026-01-13T22:21:16.027111+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-13T22:21:16.027111+00:00"
}