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": "e8b131f1-ce87-40ba-ba44-b1680aaf54ed",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "271bd0b4-301f-4cc5-a9cc-dc2f33264c93",
"company_code": "sample string 5",
"company": {
"id": "b409e7ce-a9f3-4fd9-8181-e18d38505b04",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-01T03:27:15.8453155+00:00",
"sales_territory_id": "81e58e77-458c-480d-846b-137d1d56e541",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "86b5952d-ed7e-405b-b046-6062a02dd2bb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b30021a9-7bf0-4b81-8310-c36ae04296ab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3405e6fb-75d7-49e3-bd5b-25c780ab4c15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "193a1171-d024-4d38-950f-3d4e864d3945",
"db_currency_id": "16065b69-3930-4ef2-af8b-507891a218d0",
"db_language_id": "9fe02429-b4ba-41b8-9096-aaf6f274325c",
"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-01T03:27:15.8453155+00:00"
},
"modified_dateutc": "2026-08-01T03:27:15.8453155+00:00"
},
"marketing_segment_id": "7cf1f9f6-076e-45bb-bc15-6efd73cc4aa8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a848c41d-185e-42bb-baf2-29c4b5a29dbc",
"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": "f81bd370-e151-4778-9114-bb9e3b1a074e",
"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": "a0efd544-a0b0-4066-8678-875d6319ffb1",
"db_country_code": "sample string 28",
"feelist_id": "40d4a894-e8ed-483a-b37c-f576df30fd80",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "68d8e629-005c-4a79-a542-10b128cd54bf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fb8568cb-d3e2-4c97-b2a6-12b8d2170e50",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-01T03:27:15.8453155+00:00",
"db_currency_id": "93199310-8f4c-4a6f-a7c6-a3987a945d69",
"db_currency_code": "sample string 10"
},
"company_type_id": "68923548-6795-429e-a705-96fdd53575ce",
"company_type_name": "sample string 32",
"company_type": {
"id": "31115d65-a586-46bd-96fd-5f5e3b36e2cf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "894535a9-91ed-411b-bdb7-8dbf28f2bad6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "36d558d5-030b-4a08-a81f-6c988a5957b8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "577e6e03-48f3-43ba-b8db-eaea0e40d8ce",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b20459ae-eda7-4c6a-a0ad-845f7b36976a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e85945a8-eac6-40c1-8fcf-d00721c4dd43",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-01T03:27:15.8453155+00:00"
},
"company_sector_id": "447b55fd-ac4d-472f-a6d1-4d61cd934646",
"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": "64d6a51a-ec34-40ed-afe0-11c4529ae5ad",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6c2ffd92-83bb-4003-ad30-2da727e33b63",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1798bf30-3478-438a-82c6-8586bc554b4d",
"account_manager_user_code": "sample string 56",
"company_status_id": "030e5b0f-bd47-4b8b-8f3e-460974dd4ab3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-01T03:27:15.8453155+00:00",
"id2": 60
},
"db_language_id": "e2b0ff00-893d-4393-ad81-873a2365364f",
"db_language_code": "sample string 7",
"db_title_id": "5391c9bc-badf-459e-9c51-a6364ac1db18",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-01T03:27:15.8453155+00:00",
"create_date": "2026-08-01T03:27:15.8453155+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-01T03:27:15.8453155+00:00"
}