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": "532e321e-1547-4fe8-bb9e-38f8bf7dfbcd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c4a2d980-88b3-42ad-b38d-5c8343d30d20",
"company_code": "sample string 5",
"company": {
"id": "48cca779-1ad3-4b88-bfb3-4dcc8bab62cd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-07T17:58:03.1297984+00:00",
"sales_territory_id": "4cb74aa5-d474-42a2-a53b-d5f1bf7f2aba",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "edac2f49-c273-4052-b3f6-8e8d7f3b33e4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "175e9790-c8e5-4bdd-aa21-e6a61e45cb22",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ce158b5c-d76a-4bd7-aae7-f8ac11fd0f00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee64800b-6a2d-4fad-a167-7521b5e64ed8",
"db_currency_id": "e83fb65c-5bed-4867-a165-c1da7022b6aa",
"db_language_id": "43e3ec7b-b56f-4a02-b656-0fd2f52e9d87",
"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-07T17:58:03.1297984+00:00"
},
"modified_dateutc": "2026-06-07T17:58:03.1297984+00:00"
},
"marketing_segment_id": "1df3546b-3bf4-484b-9ece-3d458e65997a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bb37eddd-8fb8-4163-92c7-365451590bcb",
"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": "10182fc6-de17-4eb3-8c03-598957f018b0",
"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": "2822ebc4-155a-43ab-bf05-af7186a9e10e",
"db_country_code": "sample string 28",
"feelist_id": "269f1444-ea33-48cb-9f3e-b2673a645de5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4e96e17d-b1a6-4f27-bf02-7007dda2b505",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "61d30d8a-b193-4b41-b129-20d97aeff334",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-07T17:58:03.1297984+00:00",
"db_currency_id": "21f9c4a4-bd8e-4266-8583-93f2e96ae455",
"db_currency_code": "sample string 10"
},
"company_type_id": "546634eb-e635-4dd0-9410-3d5b5369c438",
"company_type_name": "sample string 32",
"company_type": {
"id": "f266efe2-9909-40a6-b77d-f18b9600210f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e0d22bba-8d11-43a1-970c-70e1a3b5e7c3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0a545114-8a2e-409d-8bc8-0ff4c1157c54",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "972fc2df-a436-466c-8869-339569629e80",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9931d0a2-df7d-4d30-9d08-24f4777119b9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "20b3f6fb-5354-4a33-98a7-050d350fa77e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-07T17:58:03.1297984+00:00"
},
"company_sector_id": "b5dff32d-217d-4954-9438-d320aa9f2d5e",
"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": "81353824-8580-48f3-b084-41163968b76a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7c539b62-e496-4464-975d-82439fe42992",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6ea9d603-dacc-48af-b24a-cc8e057879cd",
"account_manager_user_code": "sample string 56",
"company_status_id": "c2d21c92-e1c2-43b2-9044-cbee9afccd03",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-07T17:58:03.1297984+00:00",
"id2": 60
},
"db_language_id": "7a8c368a-9fc7-46ae-ad6d-5ba532df25a7",
"db_language_code": "sample string 7",
"db_title_id": "dc632bac-0fd4-4814-8d45-5e8b40123913",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-07T17:58:03.1297984+00:00",
"create_date": "2026-06-07T17:58:03.1297984+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-07T17:58:03.1297984+00:00"
}