BrewForge Docs

Get a brewer's community profile

A brewer's community profile: bio, follower counts, whether the user follows them, the recipes they shared (share_token for adopt_shared_recipe) and their recent activity. Example: { "brewer": "hopfenhans" }. Without brewer: the user's OWN community profile with its settings (handle, visibility, bio, activity options; change them with update_community_profile), followers / following / blocked lists and recent community notices (follows, cheers, copies brewed). Scope: `community:read` (or `read`).

POST
/api/v1/actions/get_brewer_profile

A brewer's community profile: bio, follower counts, whether the user follows them, the recipes they shared (share_token for adopt_shared_recipe) and their recent activity. Example: { "brewer": "hopfenhans" }. Without brewer: the user's OWN community profile with its settings (handle, visibility, bio, activity options; change them with update_community_profile), followers / following / blocked lists and recent community notices (follows, cheers, copies brewed).

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

brewer?string

The brewer: their handle (with or without @, e.g. "hopfenhans") as shown by browse_community or get_brewer_profile, or their user id from a connections list. Omit for the user's own profile.

[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_brewer_profile" \  -H "Content-Type: application/json" \  -d '{}'
{
  "brewer": {
    "handle": "string",
    "name": "string",
    "location": "string",
    "bio": "string",
    "brewing_since": 0,
    "brewhouse": "string",
    "url": "string"
  },
  "is_you": true,
  "you_follow": true,
  "followers": 0,
  "following": 0,
  "brews_brewed": 0,
  "shared_recipes": [
    {
      "brew_id": "string",
      "name": "string",
      "style": "string",
      "abv_pct": 0,
      "ibu": 0,
      "last_brewed": "string",
      "brewed_by": 0,
      "cheers": 0,
      "share_token": "string"
    }
  ],
  "recent_activity": [
    {
      "kind": "brewed",
      "date": "string",
      "brewer": {
        "handle": "string",
        "name": "string",
        "location": "string"
      },
      "brew_id": "string",
      "beer": "string",
      "style": "string",
      "milestone": 0,
      "share_token": "string",
      "based_on": "string",
      "cheers": 0,
      "cheered_by_you": true
    }
  ],
  "settings": {
    "handle": "string",
    "handle_saved": true,
    "visibility": "private",
    "bio": "string",
    "location": "string",
    "brewing_since": 0,
    "brewhouse": "string",
    "activity_mode": "listed",
    "activity_events": {
      "property1": true,
      "property2": true
    },
    "notify_recipe_brewed": true,
    "indexable": true,
    "suspended": true
  },
  "connections": {
    "followers": [
      {
        "user_id": "string",
        "handle": "string",
        "name": "string",
        "since": "string",
        "you_follow_them": true
      }
    ],
    "following": [
      {
        "user_id": "string",
        "handle": "string",
        "name": "string",
        "since": "string",
        "you_follow_them": true
      }
    ],
    "blocked": [
      {
        "user_id": "string",
        "handle": "string",
        "name": "string",
        "since": "string",
        "you_follow_them": true
      }
    ],
    "truncated": true
  },
  "notices": {
    "unread": 0,
    "items": [
      {
        "property1": null,
        "property2": null
      }
    ]
  }
}
{
  "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": {}
  }
}