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": "3f37de31-c1c7-4184-9fc5-10a91bd937b5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b28cb66d-d385-495f-9e67-3c894f0b5664",
"company_code": "sample string 5",
"company": {
"id": "d26ca7dc-56f7-41c5-b51c-91bc2c7cfafb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-10T13:46:22.4050211+00:00",
"sales_territory_id": "e761b608-e02f-4cbc-b631-d55202f2d60f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3dbfad58-af70-4f0f-8a4f-568362f65033",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c9b6bb5d-e8c2-4cb6-81c4-721d57322d4a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b69232e9-b407-46c1-8edb-d535972e3be9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "12c7d990-b17f-4a83-a8ff-2fd5c1541af2",
"db_currency_id": "f98a8f49-7501-49aa-95d7-1a307a7049d5",
"db_language_id": "c03c4773-9481-4e4d-b095-39a49b26ffb4",
"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-10T13:46:22.4050211+00:00"
},
"modified_dateutc": "2025-12-10T13:46:22.4050211+00:00"
},
"marketing_segment_id": "2a3091a0-8e78-461d-a119-a108faba7f66",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4f959f58-3ffd-43f4-ad9a-cc83fc58c0d2",
"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": "30f30945-9d07-40e4-aacc-991f6e3deede",
"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": "570868b3-6466-429a-96b5-23fc2a84d865",
"db_country_code": "sample string 28",
"feelist_id": "1656f704-93e1-4d12-bd6c-491c849ec589",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "18e19c61-493e-496e-bfc7-8f21a90ae505",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d64e2792-3dbc-444b-af57-cb69644e4f22",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-10T13:46:22.4050211+00:00",
"db_currency_id": "140796a1-df6e-4409-bd46-c878bab3e405",
"db_currency_code": "sample string 10"
},
"company_type_id": "f5d90656-3544-483c-84ca-0e913f487752",
"company_type_name": "sample string 32",
"company_type": {
"id": "16e4c005-ebf0-420f-9508-b2f5d5c80f88",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "54c5fa56-9e50-4f07-8654-a0f8e2c33292",
"sales_organization_code": "sample string 5"
},
"db_language_id": "43bbb2d8-bc68-4a64-8879-57944f1a9283",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "15072e6d-a850-4b6c-ba4d-3fff8fd9a884",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "788cc20c-358d-4751-92f9-d7cd6cd63108",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "62ffad58-215c-4f36-89f1-d2060bbe787d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-10T13:46:22.4050211+00:00"
},
"company_sector_id": "49e89a93-50c2-447f-9c8d-6576dcdbbd55",
"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": "9a58bccd-00b5-487c-a7ce-14150c9ba85d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "30904102-07cd-4771-b364-a713fb5ec7ae",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "00da419e-79a7-46de-aac7-8d806cc089ba",
"account_manager_user_code": "sample string 56",
"company_status_id": "38e01bcf-f49a-4978-b37d-611a2699d3b8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-10T13:46:22.4050211+00:00",
"id2": 60
},
"db_language_id": "1bac27b8-0d1c-44a0-8a35-5537cca49a82",
"db_language_code": "sample string 7",
"db_title_id": "1cffe027-5774-4f10-bba5-8055a83cef6a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-10T13:46:22.4050211+00:00",
"create_date": "2025-12-10T13:46:22.4050211+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-10T13:46:22.4050211+00:00"
}