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": "7e997f0f-0d20-4682-be15-2f5d89ea4c7a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0736961d-03b9-4e91-bb0c-7b1051313fc1",
"company_code": "sample string 5",
"company": {
"id": "770e2cca-c365-4955-9727-5b9240803c4c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-30T02:27:37.426091+00:00",
"sales_territory_id": "73e52dd2-9acd-4467-9158-3fa507829c3a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bc27eb77-2807-4c1b-9b28-ecc57b39b03d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3f69a928-f274-4e4a-9f23-4004beb8b0eb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e8d7e2a0-671a-4679-bc21-3eb4151adca2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6fe611aa-1fd7-4507-bbe1-615f3ada18f3",
"db_currency_id": "5d98a7a8-2f0c-4252-b175-2f0c4b408cc6",
"db_language_id": "24d81e5c-c4a7-4f72-b841-485466f14fb0",
"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": "2025-12-30T02:27:37.426091+00:00"
},
"modified_dateutc": "2025-12-30T02:27:37.426091+00:00"
},
"marketing_segment_id": "d275e6e1-b422-4f78-98b9-006ae90633c5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "91e07751-4518-4214-b6b6-8ba20403bed3",
"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": "8e0817a5-66dd-4d20-ab21-c604ccc9e120",
"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": "0bd5a5c9-d265-4670-aa5d-c30db6d58d76",
"db_country_code": "sample string 28",
"feelist_id": "6d702d09-75c2-43fd-aa8c-05970acb81d3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7afc6180-e900-45db-97fb-21b566e1b087",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2db96ed1-4559-4e7a-9d4b-72038535edb0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-30T02:27:37.426091+00:00",
"db_currency_id": "3f0399ab-e52f-4a3c-92a8-ce4ef6aabf26",
"db_currency_code": "sample string 10"
},
"company_type_id": "5f9fb89d-08fb-4e0a-94f1-511204566858",
"company_type_name": "sample string 32",
"company_type": {
"id": "eafaf991-0107-4341-9b19-d649092d287f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0006a47e-927e-4047-a74d-0ee8346df332",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d108c379-37ca-4ce1-bfa8-2d09b13b7967",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6638c572-d058-4402-aa99-e71d6066d2b2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f7137fd3-c1d5-49f0-bb12-016b779c9a65",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5656f2e7-869b-4d3f-a426-36acbdd6dd05",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-30T02:27:37.426091+00:00"
},
"company_sector_id": "4956f6d4-73b1-4abb-aaa0-b3f988cfcb77",
"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": "7ec13eca-02a0-46de-a426-51da50784318",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "766493e6-f583-4286-aaa8-9a84f402ac5d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "71b12373-e185-4a69-b89b-03a236878380",
"account_manager_user_code": "sample string 56",
"company_status_id": "04523337-60e6-45db-90f6-0c46ebe15277",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-30T02:27:37.426091+00:00",
"id2": 60
},
"db_language_id": "d3ba047d-0cbf-4749-ae19-cbc4a07eb53f",
"db_language_code": "sample string 7",
"db_title_id": "934ac46b-73f9-4c99-a3d4-4271324c882b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-30T02:27:37.426091+00:00",
"create_date": "2025-12-30T02:27:37.426091+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": "2025-12-30T02:27:37.426091+00:00"
}