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": "2b8f127c-3fc7-4910-a924-7f53273b991e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1590ad4a-6c20-44d6-a771-30579874fef6",
"company_code": "sample string 5",
"company": {
"id": "75232862-6f02-4059-8a7f-2e3cf4a2c9af",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-10T14:56:06.8862519+00:00",
"sales_territory_id": "f0d94ec3-8b3e-425b-b0e4-7a00bca19005",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "855730c9-71b9-4116-8fcb-403a15cea47b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d6ffa5c4-f1a5-4842-8dcc-84ee3779a1bd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "425edd0f-b888-4104-a456-eb0b4561595d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34ca29a0-bba2-4324-92d0-5b61232cfbde",
"db_currency_id": "4d1e2ce4-dbca-4d25-811d-0a77443a33ec",
"db_language_id": "d8095d9a-a58e-49f5-8c03-c4bb70443ed1",
"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-08-10T14:56:06.8862519+00:00"
},
"modified_dateutc": "2026-08-10T14:56:06.8862519+00:00"
},
"marketing_segment_id": "25365e7c-7cd9-4c06-bf5c-a2796ed80083",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f42dce6b-81b8-4b06-b0b1-bdb649f63609",
"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": "e5505581-9b47-4f4f-9bf1-85484a5ad478",
"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": "265db0bb-bf7f-4189-babf-1fd2169d949b",
"db_country_code": "sample string 28",
"feelist_id": "f07287ff-f502-42b3-938a-9c5cb056d386",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d8f73982-1cf1-4750-ab18-7a260dcbf04e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3d3312b0-d66a-4bac-b3dc-4a825c3b0e95",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-10T14:56:06.8862519+00:00",
"db_currency_id": "05394b8c-0831-4991-aeb7-0cef8d587dc9",
"db_currency_code": "sample string 10"
},
"company_type_id": "85d64156-d795-43b2-970c-5e92516e78de",
"company_type_name": "sample string 32",
"company_type": {
"id": "0f2f9b1b-1425-43f2-9f30-339a47f5fa67",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6aa63884-0d5e-4c08-a888-a152c255cee5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "31666845-2431-4724-9c72-2652dd2558b9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "96db9c26-662d-491e-8cb3-b0f38b417c36",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "12cff3c6-6f18-4294-985a-e4d7c7fa3cbc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ee76bb69-ebbc-4ee2-b6fc-c89133276e15",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-10T14:56:06.8862519+00:00"
},
"company_sector_id": "130304a6-a973-422f-8cd7-82314c7ffce0",
"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": "f1f9ac63-8fff-4adc-a254-4d955e6f5f3f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f0e2c5ab-e86a-45e9-8d91-528bf5933548",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "60c72455-10a3-4e19-82f6-f4ff3b063571",
"account_manager_user_code": "sample string 56",
"company_status_id": "3a0f96fb-700c-47ff-bf66-4a74cad8977d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-10T14:56:06.8862519+00:00",
"id2": 60
},
"db_language_id": "5240b28e-0082-4a90-aeb1-efe757f0349f",
"db_language_code": "sample string 7",
"db_title_id": "0a8f1e0d-d996-47e6-9ccd-376c3019091d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-10T14:56:06.8862519+00:00",
"create_date": "2026-08-10T14:56:06.8862519+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-08-10T14:56:06.8862519+00:00"
}