List fermentation devices
The brewer's hydrometers and sensors (iSpindel, Tilt, RAPT Pill, GravityMon, Plaato Airlock, ...) with the brew each one logs to, its last gravity/temperature/battery and when it was last seen. Send device to see that one device's raw data log (newest first), e.g. to check whether it is sending. Gravities in SG, temperatures in °C. Needs the plan feature `device_integrations`. Scope: `brews:read` (or `read`).
The brewer's hydrometers and sensors (iSpindel, Tilt, RAPT Pill, GravityMon, Plaato Airlock, ...) with the brew each one logs to, its last gravity/temperature/battery and when it was last seen. Send device to see that one device's raw data log (newest first), e.g. to check whether it is sending. Gravities in SG, temperatures in °C.
Needs the plan feature device_integrations. Scope: brews:read (or read).
API token in format: bfk_. Each operation lists the token scope it requires (the scopes are listed below).
read: Read everything (all areas)write: Create, change and delete everything (all areas)brews:read: List and view brewsbrews:write: Create, update, delete brews and notesinventory:read: List inventory itemsinventory:write: Create, update, delete inventory itemsequipment:read: List equipment profilesequipment:write: Create, update, delete equipment profilesstyles:read: List style profilesstyles:write: Create, update, delete style profilesprofiles:read: List mash, fermentation, and water profilescustom-fields:read: List custom field definitionscustom-fields:write: Create, update, delete custom field definitionsprofiles:write: Create, update, delete mash, fermentation, and water profilescellar:read: View cellar, packaged stock, tap lists, and labelscellar:write: Manage cellar, packaging, stock, tap lists, and labelssettings:read: View preferences, imports, calculators, and your data exportsettings:write: Change preferences and undo importscommunity:read: View community, feedback, tickets, inbox, and account overviewcommunity:write: Post, vote, and reply in community, feedback, and tickets
In: header
Scope: brews:read
Request Body
application/json
The device: its id or its exact name (e.g. "iSpindel blue"). Case does not matter. Omit to list all devices.
With device: how many log entries (default 20).
1 <= value <= 200Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://brewforge.sh/api/v1/actions/list_devices" \ -H "Content-Type: application/json" \ -d '{}'{
"devices": [
{
"id": "string",
"name": "string",
"type": "string",
"brew": {
"id": "string",
"name": "string",
"status": "string"
},
"logs_keg": true,
"gravity_offset_sg": 0,
"last_seen_at": "string",
"last_gravity_sg": 0,
"last_temp_c": 0,
"last_battery": 0
}
],
"log": [
{
"at": "string",
"gravity_sg": 0,
"temp_c": 0,
"battery": 0,
"angle": 0,
"pressure_psi": 0,
"bubbles_per_minute": 0,
"logged_to_brew": true
}
],
"log_total": 0
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string",
"candidates": [
{
"id": "string",
"name": "string"
}
],
"fields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"details": {}
}
}