List custom field definitions
The brewer's own custom fields: extra values they record on brews (scope "brew", shown in a section given by placement: brew_details, brew_day, fermentation, packaging, tasting) or on brew notes (scope "brew_note"). Each has a key, name, type (text, number, integer, date, time, datetime, boolean, select, url), choices for select fields, unit and default. Archived fields are hidden in the app; include_archived: true lists them too. Create or change them with save_custom_field. Scope: `custom-fields:read` (or `read`).
The brewer's own custom fields: extra values they record on brews (scope "brew", shown in a section given by placement: brew_details, brew_day, fermentation, packaging, tasting) or on brew notes (scope "brew_note"). Each has a key, name, type (text, number, integer, date, time, datetime, boolean, select, url), choices for select fields, unit and default. Archived fields are hidden in the app; include_archived: true lists them too. Create or change them with save_custom_field.
Scope: custom-fields: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: custom-fields:read
Request Body
application/json
true: also list archived fields. Default false.
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/list_custom_fields" \ -H "Content-Type: application/json" \ -d '{}'{
"items": [
{
"id": "string",
"key": "string",
"name": "string",
"type": "string",
"scope": "string",
"placement": "string",
"choices": [
"string"
],
"unit": "string",
"placeholder": "string",
"default_value": "string",
"description": "string",
"required": true,
"display_order": 0,
"archived": true,
"archived_at": "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": {}
}
}