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`).
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).
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: read
Request Body
application/json
Which part of the export to return. Omit for the overview.
"user" | "subscription" | "preferences" | "brews" | "inventory" | "profiles" | "orderLists" | "customFields" | "devices" | "cellar" | "bjcpEvaluations" | "feedback" | "bountyTransactions" | "messages" | "apiTokens" | "ingredientSubscriptions" | "customIngredientPackages" | "migrationRequests"List sections: records per page (default 5; brews are large, keep it small).
1 <= value <= 50next_cursor from the previous page of the same section.
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": {}
}
}