BrewForge Docs

Find feedback threads (feature requests, questions, roadmap)

Search BrewForge's public Feedback board (brewforge.sh/feedback): feature requests and questions from all brewers, with votes and status. With query: the threads most similar to the text (full-text, finds rewordings), e.g. { "query": "water chemistry per mash step" }. ALWAYS search like this before post_feedback to avoid duplicates; results are the closest threads, not necessarily the same request, so compare titles (and read a thread when unsure). roadmap: true lists the feature requests on the roadmap (under_review, planned, in_progress, shipped); for what is coming next add status: ["planned", "in_progress"]. mine: "voted" / "commented" lists the user's own. Then get_feedback_thread for the full thread, react_to_feedback to vote. Scope: `community:read` (or `read`).

POST
/api/v1/actions/find_feedback_threads

Search BrewForge's public Feedback board (brewforge.sh/feedback): feature requests and questions from all brewers, with votes and status. With query: the threads most similar to the text (full-text, finds rewordings), e.g. { "query": "water chemistry per mash step" }. ALWAYS search like this before post_feedback to avoid duplicates; results are the closest threads, not necessarily the same request, so compare titles (and read a thread when unsure). roadmap: true lists the feature requests on the roadmap (under_review, planned, in_progress, shipped); for what is coming next add status: ["planned", "in_progress"]. mine: "voted" / "commented" lists the user's own. Then get_feedback_thread for the full thread, react_to_feedback to vote.

Scope: community: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: community:read

Request Body

application/json

query?string

What the thread is about, in plain words (at least 4 characters), e.g. "export to BeerXML". Ranked by similarity; max 10 results, no paging.

Lengthlength <= 200
category?string

feature (feature requests) or question.

Value in"feature" | "question"
status?array<>

Only these statuses, e.g. ["planned", "in_progress"]. Features: open, under_review, planned, in_progress, shipped, declined. Questions: open, answered, closed.

roadmap?boolean

Only feature requests on the roadmap board (under_review, planned, in_progress, shipped), most voted first.

mine?string

Only threads the user upvoted or posted in.

Value in"voted" | "commented"
input_wanted?boolean

Only threads with an open questionnaire the user has not answered yet.

sort?string

Without query: top (most votes, default), trending (votes in the last weeks), new, or active (latest activity).

Value in"top" | "trending" | "new" | "active"
limit?integer

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

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_feedback_threads" \  -H "Content-Type: application/json" \  -d '{}'
{
  "items": [
    {
      "number": 0,
      "title": "string",
      "category": "feature",
      "status": "open",
      "votes": 0,
      "you_voted": true,
      "replies": 0,
      "summary": "string",
      "labels": [
        "string"
      ],
      "your_input_wanted": true,
      "author": "string",
      "last_activity": "string",
      "url": "string"
    }
  ],
  "next_cursor": "string",
  "total": 0,
  "note": "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": {}
  }
}