BrewForge Docs

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`).

POST
/api/v1/actions/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).

AuthorizationBearer <token>

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 brews
  • brews:write: Create, update, delete brews and notes
  • inventory:read: List inventory items
  • inventory:write: Create, update, delete inventory items
  • equipment:read: List equipment profiles
  • equipment:write: Create, update, delete equipment profiles
  • styles:read: List style profiles
  • styles:write: Create, update, delete style profiles
  • profiles:read: List mash, fermentation, and water profiles
  • custom-fields:read: List custom field definitions
  • custom-fields:write: Create, update, delete custom field definitions
  • profiles:write: Create, update, delete mash, fermentation, and water profiles
  • cellar:read: View cellar, packaged stock, tap lists, and labels
  • cellar:write: Manage cellar, packaging, stock, tap lists, and labels
  • settings:read: View preferences, imports, calculators, and your data export
  • settings:write: Change preferences and undo imports
  • community:read: View community, feedback, tickets, inbox, and account overview
  • community:write: Post, vote, and reply in community, feedback, and tickets

In: header

Scope: profiles:read

Request Body

application/json

kind?string

Only profiles of this kind: "equipment", "mash", "fermentation", "water" or "hop_stand". Default: all kinds.

Value in"equipment" | "mash" | "fermentation" | "water" | "hop_stand"
query?string

Only profiles whose name contains this text. Example: "grainfather".

templates?boolean

true: list the templates BrewForge offers (not the brewer's own profiles). Default false.

limit?integer

How many rows to return, 1-100 (default 50).

Range1 <= value <= 100
cursor?string

next_cursor from the previous page, to get the next page. Omit for the first page.

[key: string]?never

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": {}
  }
}