Find profiles
List the brewer's own profiles: equipment, mash, fermentation, water and hop stand curves, with the default of each kind marked is_default. Each row has a one-line summary (batch size, mash steps, fermentation stages, water ions). Use get_profile for every setting. With templates: true it lists the ready-made templates BrewForge offers instead (e.g. Grainfather G30, Burton on Trent water); add one with create_profile { template }. Volumes in litres, temperatures in °C, ions in mg/L. Scope: `profiles:read` (or `read`).
List the brewer's own profiles: equipment, mash, fermentation, water and hop stand curves, with the default of each kind marked is_default. Each row has a one-line summary (batch size, mash steps, fermentation stages, water ions). Use get_profile for every setting. With templates: true it lists the ready-made templates BrewForge offers instead (e.g. Grainfather G30, Burton on Trent water); add one with create_profile { template }. Volumes in litres, temperatures in °C, ions in mg/L.
Scope: profiles: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: profiles:read
Request Body
application/json
Only profiles of this kind: "equipment", "mash", "fermentation", "water" or "hop_stand". Default: all kinds.
"equipment" | "mash" | "fermentation" | "water" | "hop_stand"Only profiles whose name contains this text. Example: "grainfather".
true: list the templates BrewForge offers (not the brewer's own profiles). Default false.
How many rows to return, 1-100 (default 50).
1 <= value <= 100next_cursor from the previous page, to get the next page. Omit for the first page.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://brewforge.sh/api/v1/actions/find_profiles" \ -H "Content-Type: application/json" \ -d '{}'{
"items": [
{
"id": "string",
"kind": "equipment",
"name": "string",
"is_default": true,
"batch_volume_l": 0,
"boil_time_min": 0,
"brewhouse_efficiency_pct": 0,
"steps": "string",
"stages": "string",
"ions_ppm": "string",
"points": "string"
}
],
"next_cursor": "string"
}{
"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": {}
}
}