Featurebase

Boards

Boards (also known as categories) are used for categorizing feedback in your Featurebase organization. Common examples include "💡 Feature Request", "🐛 Bug Reports", and "📥 Feedback". On this page, we'll explore the different board endpoints you can use to retrieve information about your boards programmatically.

The board model

The Board model contains information about the categories used to organize posts in your Featurebase platform. Boards and categories are interchangeable terms and refer to the same concept.

Properties

  • Name
    id
    Type
    string
    Description

    The unique identifier of the board. Example: "674f510262f60eda2cf71e39"

  • Name
    category
    Type
    string
    Description

    The name of the board/category. Example: "Feature Requests"

  • Name
    private
    Type
    boolean
    Description

    Flag indicating whether this board is private.

  • Name
    segmentIds
    Type
    Array<string>
    Description

    An array of segment IDs associated with this board.

  • Name
    roles
    Type
    Array<string>
    Description

    An array of roles that have access to this board.

  • Name
    hiddenFromRoles
    Type
    Array<string>
    Description

    An array of roles that cannot see this board.

  • Name
    disablePostCreation
    Type
    boolean
    Description

    Flag indicating whether post creation is disabled for this board.

  • Name
    disableFollowUpQuestions
    Type
    boolean
    Description

    Flag indicating whether follow-up questions are disabled for this board.

  • Name
    customInputFields
    Type
    Array<string>
    Description

    An array of custom input fields ids that apply to this board.

  • Name
    defaultAuthorOnly
    Type
    boolean
    Description

    Flag indicating whether posts in this board are visible to the author only by default.

  • Name
    defaultCompanyOnly
    Type
    boolean
    Description

    Flag indicating whether posts in this board are visible to the company only by default.

  • Name
    icon
    Type
    Object
    Description

    The icon associated with this board. Can be null.

GET/v2/boards

List boards

This endpoint allows you to retrieve a list of all boards (categories) in your Featurebase organization.

Request

GET
/v2/boards
curl -G https://do.featurebase.app/v2/boards \
  -H "X-API-Key: {token}"

Response

{
  "success": true,
  "results": [
    {
      "category": "Feature Requests",
      "private": false,
      "segmentIds": [],
      "roles": [],
      "hiddenFromRoles": [],
      "disablePostCreation": false,
      "disableFollowUpQuestions": false,
      "customInputFields": [],
      "defaultAuthorOnly": false,
      "defaultCompanyOnly": false,
      "icon": null,
      "id": "674f510262f60eda2cf71e39"
    }
  ]
}
GET/v2/boards/:id

Get board by ID

This endpoint allows you to retrieve details for a specific board by providing its unique identifier.

Required URL Parameters

  • Name
    id
    Type
    string
    Description

    The unique identifier of the board to retrieve.

Request

GET
/v2/boards/:id
curl -G https://do.featurebase.app/v2/boards/674f510262f60eda2cf71e39 \
  -H "X-API-Key: {token}"

Response

{
  "category": "Feature Requests",
  "private": false,
  "segmentIds": [],
  "roles": [],
  "hiddenFromRoles": [],
  "disablePostCreation": false,
  "disableFollowUpQuestions": false,
  "customInputFields": [],
  "defaultAuthorOnly": false,
  "defaultCompanyOnly": false,
  "icon": null,
  "id": "674f510262f60eda2cf71e39"
}