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": "cad2771e-126a-4468-8667-c8e42164ebf5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "02f9ab85-1cfa-41a7-a8ab-2aaaf003a3e7",
"company_code": "sample string 5",
"company": {
"id": "b17a41c0-41a6-4739-b8f9-14a3a28caf07",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-01T04:53:13.4617585+00:00",
"sales_territory_id": "b4b541ef-ab67-4963-b013-3249795dda55",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1043454e-6a32-44a8-ba36-fad8b4af220f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "906cffa3-4ed0-407f-a950-c07f157235f5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "62715fab-8d74-4ddc-82f2-5908bd700192",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9eccf884-4dcd-44d3-a9f4-ab0e57e8a256",
"db_currency_id": "f1b40bc4-8d6d-4a6e-a9de-1e1fac23ceca",
"db_language_id": "2cf3078f-8114-4eed-8c6f-0dc38853db56",
"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-01T04:53:13.4617585+00:00"
},
"modified_dateutc": "2026-06-01T04:53:13.4617585+00:00"
},
"marketing_segment_id": "42001a4e-433f-4c99-89f2-acb00eac2e27",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5f0e2fbe-e75c-4387-83f5-71eb6735a937",
"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": "f16e2c38-d1da-464f-8d6c-e091ba0506ad",
"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": "96b8fbc6-29fa-4f4e-8707-067c60acfae4",
"db_country_code": "sample string 28",
"feelist_id": "0e61764d-67d1-47e5-bb39-d54810fb1536",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b54b01ce-7fdd-406e-9fee-135860a2787c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8533b372-e8c5-4569-90ad-593f8d55df14",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-01T04:53:13.4617585+00:00",
"db_currency_id": "32cf3cb9-d4e6-49fa-8339-6258b0855bd6",
"db_currency_code": "sample string 10"
},
"company_type_id": "580a88ca-d7c0-48f7-ac75-64c308d86dd6",
"company_type_name": "sample string 32",
"company_type": {
"id": "dc69cb4b-8ef7-4dbc-b2d4-fd3acc016177",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f64eacac-8a45-419b-8325-c9aa8ac3bb63",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c0fb0306-665b-4276-9db3-a0f74d1254b5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "40cd09e9-1902-46c4-9b07-cfa938c6bffa",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f8cee4ea-298f-431c-b9a1-b0803b195e55",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "feec60c1-b769-4e7a-bb8d-36cc0fb3215d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-01T04:53:13.4773857+00:00"
},
"company_sector_id": "bb07b0b9-9712-4699-9321-1e2ab8c1721a",
"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": "f62d7228-685f-4258-9938-3a29375f4847",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4a9ff99a-baec-41c7-8c5c-4cdc85d593ee",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "35c32e25-92b8-4e37-974d-e8e3c8e3a52b",
"account_manager_user_code": "sample string 56",
"company_status_id": "ea0a2527-6aee-4921-b46a-7f52ca6355a4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-01T04:53:13.4773857+00:00",
"id2": 60
},
"db_language_id": "bdd9c27d-e274-4399-aae0-97da8232cc6a",
"db_language_code": "sample string 7",
"db_title_id": "1a20fe01-9fd1-4004-9629-027a106670cb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-01T04:53:13.4773857+00:00",
"create_date": "2026-06-01T04:53:13.4773857+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-01T04:53:13.4773857+00:00"
}