BrewForge Docs

Export the user's account data (JSON)

The full data export of the account (the same JSON as Settings → Account → Export data), in pieces because it can be several MB. Without section: the export's sections with how many records each holds. Then ask for one section at a time, e.g. { "section": "profiles" }; list sections (brews, messages, bjcpEvaluations, ...) come in pages: { "section": "brews", "limit": 5, "cursor": "..." }. Raw records with internal field names; for working with brews prefer the brewing tools. Use this for backups or when the user asks for their data. Needs a token with the full "read" scope. Scope: `read` (or `read`).

POST
/api/v1/actions/export_my_data

The full data export of the account (the same JSON as Settings → Account → Export data), in pieces because it can be several MB. Without section: the export's sections with how many records each holds. Then ask for one section at a time, e.g. { "section": "profiles" }; list sections (brews, messages, bjcpEvaluations, ...) come in pages: { "section": "brews", "limit": 5, "cursor": "..." }. Raw records with internal field names; for working with brews prefer the brewing tools. Use this for backups or when the user asks for their data. Needs a token with the full "read" scope.

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

Request Body

application/json

section?string

Which part of the export to return. Omit for the overview.

Value in"user" | "subscription" | "preferences" | "brews" | "inventory" | "profiles" | "orderLists" | "customFields" | "devices" | "cellar" | "bjcpEvaluations" | "feedback" | "bountyTransactions" | "messages" | "apiTokens" | "ingredientSubscriptions" | "customIngredientPackages" | "migrationRequests"
limit?integer

List sections: records per page (default 5; brews are large, keep it small).

Range1 <= value <= 50
cursor?string

next_cursor from the previous page of the same section.

[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/export_my_data" \  -H "Content-Type: application/json" \  -d '{}'
{
  "exported_at": "string",
  "export_version": "string",
  "sections": [
    {
      "name": "string",
      "records": 0
    }
  ],
  "approx_size_kb": 0,
  "section": "string",
  "data": null,
  "total": 0,
  "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": {}
  }
}