Hiboo Connect
The following endpoints allow you to share your equipment data with other organizations, and manage the sharing process.
Returns all Sharing instances that have been created
The number of items to skip before starting to collect the result set
The number of items to return
successful operation
Invalid input or missing parameters
Unable to authenticate the token
GET /sharings?offset=1&limit=1 HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*
{
"reference": "contract-4242-2024",
"startDate": "2025-10-14T02:24:36.561Z",
"endDate": "2025-10-14T02:24:36.561Z",
"dataPacksCodes": [
"essential",
"vehicle_conditions",
"energy_and_fuel",
"activity",
"others",
"usage_hours",
"fault_codes"
],
"assetIds": [
1,
2,
3
],
"recipient": "[email protected]",
"notificationEnabled": true,
"properties": {
"customer": "Customer Name",
"site": "Site Name",
"contract": "XK-123456",
"purchaseOrder": "0986-XX-60",
"project": "ABC-123-ZX-456",
"accountNumber": "1234"
}
}This endpoint will allow you to create a new instance of Sharing. It can be a contract for instance.
It can be a contract reference for instance
contract-4242-2024Date from which the sharing of data should start serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ). The date must not be before one rolling year.
Date when the sharing of data should stop serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ). Equipment data will be shared as long as it is empty, set it to null if the end date is unsure
All the equipment that you wish to share, use Hiboo's ids
1If false, the recipient will not be notified when the sharing is created or started
Successful operation
Invalid input or missing parameters
Unable to authenticate the token
Insufficient permissions to access the resource
POST /sharings HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 390
{
"reference": "contract-4242-2024",
"startDate": "2025-10-14T02:24:36.561Z",
"endDate": "2025-10-14T02:24:36.561Z",
"optionalDataPackCodes": [
"fault_codes"
],
"assetIds": [
1
],
"recipient": "[email protected]",
"notificationEnabled": true,
"properties": {
"customer": "Customer Name",
"site": "Site Name",
"contract": "XK-123456",
"purchaseOrder": "0986-XX-60",
"project": "ABC-123-ZX-456",
"accountNumber": "1234"
}
}{
"reference": "contract-4242-2024",
"startDate": "2025-10-14T02:24:36.561Z",
"endDate": "2025-10-14T02:24:36.561Z",
"dataPacksCodes": [
"essential",
"vehicle_conditions",
"energy_and_fuel",
"activity",
"others",
"usage_hours",
"fault_codes"
],
"assetIds": [
1,
2,
3
],
"recipient": "[email protected]",
"notificationEnabled": true,
"properties": {
"customer": "Customer Name",
"site": "Site Name",
"contract": "XK-123456",
"purchaseOrder": "0986-XX-60",
"project": "ABC-123-ZX-456",
"accountNumber": "1234"
}
}It totally deletes a Sharing as it never existed.
The reference you defined when creating the Sharing
contract-4242-2024Sharing was successfully deleted
No content
Unable to authenticate the token
Insufficient permissions to access the resource
Resource not found
Sharing cannot be deleted because it has already started or ended
DELETE /sharings/{reference} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*
No content
Update an existing sharing by reference
The reference you defined when creating the Sharing
contract-4242-2024It can be a contract reference for instance
contract-4242-2024Date from which the sharing of data should start serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ). The date must not be before one rolling year.
Date when the sharing of data should stop serialized as an ISO8601 string with a timezone (YYYY-MM-DDTHH:mm:ssZ). Equipment data will be shared as long as it is empty, so you can set it to null if the end date is unsure
Successful operation
Missing parameters or invalid parameters
Unable to authenticate the token
Insufficient permissions to access the resource
Resource not found
Sharing has already started
PATCH /sharings/{reference} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 313
{
"reference": "contract-4242-2024",
"startDate": "2025-10-14T02:24:36.561Z",
"endDate": "2025-10-14T02:24:36.561Z",
"optionalDataPackCodes": [
"fault_codes"
],
"properties": {
"customer": "Customer Name",
"site": "Site Name",
"contract": "XK-123456",
"purchaseOrder": "0986-XX-60",
"project": "ABC-123-ZX-456",
"accountNumber": "1234"
}
}{
"reference": "contract-4242-2024",
"startDate": "2025-10-14T02:24:36.561Z",
"endDate": "2025-10-14T02:24:36.561Z",
"dataPacksCodes": [
"essential",
"vehicle_conditions",
"energy_and_fuel",
"activity",
"others",
"usage_hours",
"fault_codes"
],
"assetIds": [
1,
2,
3
],
"recipient": "[email protected]",
"notificationEnabled": true,
"properties": {
"customer": "Customer Name",
"site": "Site Name",
"contract": "XK-123456",
"purchaseOrder": "0986-XX-60",
"project": "ABC-123-ZX-456",
"accountNumber": "1234"
}
}This endpoint will stop the sharing of data for the specified reference. It will not delete the sharing, but it will stop the data sharing process.
The reference you defined when creating the Sharing
contract-4242-2024successful operation
No content
Unable to authenticate the token
Insufficient permissions to access the resource
Resource not found
if the Sharing is not in progress
DELETE /sharings/{reference}/in-progress HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*
No content
Was this helpful?