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": "74116018-4b14-4baa-8149-906dbecc6139",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bcab5d58-5c1e-4fb4-8af7-65eb92ed46fc",
"company_code": "sample string 5",
"company": {
"id": "447633b0-1e96-41ba-b22b-925f385d08c6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-05T11:06:45.3347631+00:00",
"sales_territory_id": "5dc65322-82b6-4aa6-b98b-1cde39e0e4de",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "792bfb0a-5840-430b-a22f-cb48d7bcb3cf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d7525faa-e2e0-4f00-85bb-45c5342ed246",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "21e17b75-186f-40ab-b642-4efb84003a27",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3783f8a2-77c7-409c-94c1-dffb83e69a54",
"db_currency_id": "210bb5d1-2b17-4fea-afb0-30c3bb3d32fa",
"db_language_id": "779f417a-fa41-4443-84ca-286068367620",
"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-06-05T11:06:45.3347631+00:00"
},
"modified_dateutc": "2026-06-05T11:06:45.3347631+00:00"
},
"marketing_segment_id": "301bacae-392a-4a58-ac81-22e5a41397e8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b31ebf7b-5e76-4d3f-9979-bb25c790898f",
"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": "7d8383c5-756f-45ab-98ab-409fb528fa6f",
"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": "1eb489e4-5320-403d-9a78-edfb9cbedd01",
"db_country_code": "sample string 28",
"feelist_id": "586da59f-a55d-4e32-acb8-c12f5a8559d3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "30c57cc4-00f8-4753-bb04-26d7ca022065",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "88500219-0ff9-4b71-bf7f-b3baac3f44ec",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-05T11:06:45.3347631+00:00",
"db_currency_id": "4a712fde-a650-4f39-8e7f-9497b3526124",
"db_currency_code": "sample string 10"
},
"company_type_id": "047cc595-7ff1-44d5-b851-5f29fbfbb1ff",
"company_type_name": "sample string 32",
"company_type": {
"id": "bfdd94aa-c839-4ccc-8a24-615c2c3ef847",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6aba2fd0-4e87-42eb-b7b7-1f2921bf3962",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f78d1e9f-e28f-4374-a719-ba2cb1d1b563",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "37a55aa6-3de2-40da-bbb3-02a7cebb1366",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "44e0ef03-e92f-462c-a8b1-55d80de98ae6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "83416857-9546-4eea-84d2-d4df1a86bea8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-05T11:06:45.3347631+00:00"
},
"company_sector_id": "c1726033-f19a-40bc-8d52-b95c4e2c168c",
"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": "af8c4675-5c21-48da-8d83-7032a227a93b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "248a8921-d86e-4c7e-b9b8-8fe0b0e2dc57",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d5120caa-9818-40a4-9754-f84cbc3c4958",
"account_manager_user_code": "sample string 56",
"company_status_id": "047527aa-fa72-4499-b211-ebd299d5e98e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-05T11:06:45.3347631+00:00",
"id2": 60
},
"db_language_id": "20422ee8-1a95-434e-9b74-c62d033d2f51",
"db_language_code": "sample string 7",
"db_title_id": "eba105d8-5fe9-45b4-83f6-a2870ce21260",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-05T11:06:45.3347631+00:00",
"create_date": "2026-06-05T11:06:45.3347631+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-06-05T11:06:45.3347631+00:00"
}