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": "a459efef-dc45-48a2-af86-3388115add3a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "28505566-c361-4e55-aa90-09006e1c8cae",
"company_code": "sample string 5",
"company": {
"id": "c4735e77-0cad-4c82-9ef9-0abebc2e2de4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-16T09:09:06.0420447+00:00",
"sales_territory_id": "6a84cd5b-32cf-41d2-a27b-dfba45b6fe2c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c78831e9-68e8-472e-8927-2887edf6e6d9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bd6a157b-fa18-4c2e-a393-f89189460c76",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d9ffc00f-3340-4515-960f-fff54bd2338d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "08dd5ac1-3d48-4610-be78-fbc5d54b17cb",
"db_currency_id": "93bd3914-c8a0-4179-a55f-de717c59b3e6",
"db_language_id": "26b41731-8aeb-42fd-914d-6ea488e09ec4",
"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-16T09:09:06.0420447+00:00"
},
"modified_dateutc": "2025-12-16T09:09:06.0420447+00:00"
},
"marketing_segment_id": "86a80a5e-8915-4f43-badf-e6bd020d1f49",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "26d6efa3-3a51-4368-ab58-a78086bb9c8b",
"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": "dc1e239d-fe66-4f50-8027-1f34787bad30",
"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": "2d61f8e3-d3ad-4a24-ad93-55b00039dacf",
"db_country_code": "sample string 28",
"feelist_id": "39248d92-4c3e-4f5d-b1e3-4ed3cbb7d7df",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e020ee70-4bc8-4e69-bdfc-43ba626374d4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9ec0ebd0-fb98-4db8-b649-470183ced9fc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-16T09:09:06.0420447+00:00",
"db_currency_id": "1d2a97d5-bc5b-48d0-9c63-a0d790daf77c",
"db_currency_code": "sample string 10"
},
"company_type_id": "8ebabc99-458c-486b-a9a0-d4c52d7b2140",
"company_type_name": "sample string 32",
"company_type": {
"id": "32b48ade-3b1e-43e8-aa83-e59ed509a7b0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cacdc24f-b9f3-4186-86e4-73a72d676988",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ccb00f23-c170-4dde-8f37-fce8834a323b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9bef5b84-db56-44a9-aee7-3178b0a9106a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "edce51f6-380b-42a0-a94c-ea32ffd2f0a1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c9f1c069-9e9a-4f39-83b0-12f72179f89e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-16T09:09:06.0420447+00:00"
},
"company_sector_id": "8096ca9e-a7f2-4522-b375-f2cbb2d53b86",
"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": "1c651894-6a6c-432f-bcb3-4f29c1bb91d2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9a72a3fc-92d6-401a-9791-60a181d77bd1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c55b6fb3-313b-43e9-8595-d7371781a9e1",
"account_manager_user_code": "sample string 56",
"company_status_id": "6e1dd50c-4725-4a5d-a689-2ad66070d31d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-16T09:09:06.0420447+00:00",
"id2": 60
},
"db_language_id": "e40d6abc-7aa4-4929-93bf-4eb19fcb3130",
"db_language_code": "sample string 7",
"db_title_id": "24a434a3-bb41-48ae-bb6f-0d383bbb5912",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-16T09:09:06.0420447+00:00",
"create_date": "2025-12-16T09:09:06.0420447+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-16T09:09:06.0420447+00:00"
}