BrewForge Docs

Plan, limits, bounty points and referrals

The user's BrewForge plan (name; renews_on or ends_on for a paid subscription, else period_note says why there is no date), brew limit and usage, which plan features are on, the bounty point balance (points from bug reports, codes and referrals, worth discounts) and the referral link with its stats. Read only: plan changes, checkout and discounts happen in the app (brewforge.sh/subscriptions, /bounty). include: ["bounty_history"] adds the last point transactions. Scope: `community:read` (or `read`).

POST
/api/v1/actions/get_account_overview

The user's BrewForge plan (name; renews_on or ends_on for a paid subscription, else period_note says why there is no date), brew limit and usage, which plan features are on, the bounty point balance (points from bug reports, codes and referrals, worth discounts) and the referral link with its stats. Read only: plan changes, checkout and discounts happen in the app (brewforge.sh/subscriptions, /bounty). include: ["bounty_history"] adds the last point transactions.

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

include?array<>

Extra sections: bounty_history (last 50 point transactions).

[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/get_account_overview" \  -H "Content-Type: application/json" \  -d '{}'
{
  "plan": {
    "name": "string",
    "status": "string",
    "renews_on": "string",
    "ends_on": "string",
    "ends_at_period_end": true,
    "period_note": "string"
  },
  "brews": {
    "used": 0,
    "limit": 0,
    "unlimited": true,
    "locked": 0
  },
  "features": {
    "enabled": [
      "string"
    ],
    "not_enabled": [
      "string"
    ]
  },
  "bounty": {
    "points": 0,
    "history": [
      {
        "date": "string",
        "points": 0,
        "type": "string",
        "reason": "string",
        "ticket": "string"
      }
    ]
  },
  "referral": {
    "link": "string",
    "signups": 0,
    "paid_conversions": 0,
    "points_earned": 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": {}
  }
}