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": "31f5438c-6fde-4770-877b-498e7afcf309",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6ce1f9b2-c29f-4cbf-8c64-1ae00970cd27",
"company_code": "sample string 5",
"company": {
"id": "67f0e9df-0f84-4f45-bd5b-fee714dfee36",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-02T21:10:33.1062761+00:00",
"sales_territory_id": "bb5054ce-09f5-4050-b0bb-afa63e8d7d92",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d04d3030-80f6-4453-baaf-b5aa574693e3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "04d89ddb-9060-496e-907b-b8dc27f287cc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1f85ea20-661c-4750-be10-82fdcdec555f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc48ecc5-abe8-4f61-b004-fb3498c9dff2",
"db_currency_id": "90f87b5c-e3ad-49ac-b54f-019b28c0bf45",
"db_language_id": "cf5da94c-774c-4c10-a0c7-5f5f11a71bb3",
"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-04-02T21:10:33.1062761+00:00"
},
"modified_dateutc": "2026-04-02T21:10:33.1062761+00:00"
},
"marketing_segment_id": "ad0db9b8-54f1-417a-b5b7-b8cffbfec786",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6d136bc7-ba1d-49ec-a3bf-59804be82d80",
"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": "a6176feb-e483-4477-88a7-4fc217148991",
"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": "f59ca2be-1943-4bea-b82a-1204207798dc",
"db_country_code": "sample string 28",
"feelist_id": "3e81f5df-829a-463d-b593-ee0d23090a2c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1e189839-e5dc-41ee-b1d4-fb9a50888818",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "aa194c53-e0b7-4f93-8254-11adb683bba0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-02T21:10:33.1062761+00:00",
"db_currency_id": "2a0b79f0-d840-4302-9671-793de68d37a6",
"db_currency_code": "sample string 10"
},
"company_type_id": "77ffd42f-5363-43ae-b3d2-6e88972cd1b0",
"company_type_name": "sample string 32",
"company_type": {
"id": "89d1d421-3be7-4b47-a738-21a7cff7a3e8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2c7102e6-e7e3-4224-bd2f-d98657c3902a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b68c9401-72da-4ed9-95f8-1a4bf724ab3f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "01d5733c-a493-4d1c-84f7-7fedcce0a720",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c9249d74-d4fe-42e8-a14a-f1231bcaca4e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ce76f565-e4ad-4119-b1e8-f03df8919014",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-02T21:10:33.1062761+00:00"
},
"company_sector_id": "96e6e07a-4e9c-4431-9cd2-932544c5b9b1",
"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": "82b512b0-f7d4-493b-b5ba-7f4cf5122b6e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ff7e81fa-aba8-424e-8c35-97ee4f5facf0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2eb74de0-8697-4246-bc00-e60eab08d2dd",
"account_manager_user_code": "sample string 56",
"company_status_id": "d2456a75-9ac3-4195-ac4b-4bf6a60b8eca",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-02T21:10:33.1062761+00:00",
"id2": 60
},
"db_language_id": "bcdeed99-9bb8-4bfe-8665-0928aa0d12b3",
"db_language_code": "sample string 7",
"db_title_id": "3978311a-6e2c-4afd-90c4-6f3a84a36dc4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-02T21:10:33.1062761+00:00",
"create_date": "2026-04-02T21:10:33.1062761+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-04-02T21:10:33.1062761+00:00"
}