Get a board by ID

client.feedback.boards.retrieve(, ?, ?): Board { id, access, createdAt, 7 more }

GET/v2/boards/{id}

Retrieves a single board by its unique identifier.

Returns the full board object including all access controls, feature toggles, and localization settings.

ParametersExpand Collapse

id: string

Board unique identifier

params: BoardRetrieveParams { featurebaseVersion }

featurebaseVersion?: "2026-01-01.nova" | "2025-12-12.clover"

API version for this request. Defaults to your organization’s configured API version if not specified.

One of the following:

"2026-01-01.nova"

"2025-12-12.clover"

ReturnsExpand Collapse

Board { id, access, createdAt, 7 more }

id: string

Unique identifier

access: Access { adminOnly, allowedRoles, deniedRoles, segments }

adminOnly: boolean

If true, only admins can see this board

allowedRoles: Array<string>

Role IDs allowed access (empty = all)

deniedRoles: Array<string>

Role IDs explicitly denied access

segments: Array<string>

Segment IDs that can access (empty = all)

createdAt: string

ISO 8601 timestamp when created

customFields: Array<string>

Custom field IDs attached to this board

features: Features { commentsEnabled, createdDatesVisible, postingEnabled }

commentsEnabled: boolean

Whether users can comment on posts

createdDatesVisible: boolean

Whether creation dates are visible on posts

postingEnabled: boolean

Whether users can create new posts

icon: EmojiIcon { type, value } | PredefinedIcon { type, value } | URLIcon { type, value } | null

The board’s icon. Can be one of three types:

emoji: A single emoji character (e.g., 💡, 🚀, ⭐)
icon: A predefined icon from the built-in library (e.g., lightbulb, bug, star)
url: A custom image URL (HTTPS required)

Can be null if no icon is set.

One of the following:

EmojiIcon { type, value }

An emoji character as the board icon

type: "emoji"

Emoji icon type

value: string

A single emoji character

PredefinedIcon { type, value }

A predefined icon from the built-in icon library

type: "icon"

Predefined icon type

value: string

Icon name from the predefined icon set (e.g., lightbulb, bug, star, rocket, flag, heart, check, question, megaphone, gift)

URLIcon { type, value }

A custom icon loaded from an external URL

type: "url"

External URL icon type

value: string

HTTPS URL to a custom icon image (PNG, SVG, or WebP recommended)

formaturi

localization: Localization { description, formPlaceholder, heroDescription, 3 more }

description: Record<string, string> | null

Localized description

formPlaceholder: Record<string, string> | null

Placeholder text in the post creation form

heroDescription: Record<string, string> | null

Hero description/subtitle

heroTitle: Record<string, string> | null

Hero title shown on the board page

name: Record<string, string>

Localized board name (language code → text)

submitButtonText: Record<string, string> | null

Submit button text

name: string

Display name in organization’s default locale

object: "board"

Object type identifier

postDefaults: PostDefaults { visibility }

visibility: "public" | "authorOnly" | "companyOnly"

Default visibility for new posts

One of the following:

"public"

"authorOnly"

"companyOnly"

Get a board by ID

import Featurebase from 'featurebase-node';

const client = new Featurebase({
  apiKey: process.env['FEATUREBASE_API_KEY'], // This is the default and can be omitted
});

const board = await client.feedback.boards.retrieve('507f1f77bcf86cd799439011');

console.log(board.id);

{
  "id": "507f1f77bcf86cd799439011",
  "access": {
    "adminOnly": false,
    "allowedRoles": [
      "string"
    ],
    "deniedRoles": [
      "role_blocked"
    ],
    "segments": [
      "string"
    ]
  },
  "createdAt": "2023-12-12T00:00:00.000Z",
  "customFields": [
    "cf_priority",
    "cf_category"
  ],
  "features": {
    "commentsEnabled": true,
    "createdDatesVisible": true,
    "postingEnabled": true
  },
  "icon": {
    "type": "emoji",
    "value": "💡"
  },
  "localization": {
    "description": {
      "en": "Submit and vote on feature ideas"
    },
    "formPlaceholder": {
      "en": "Describe your feature idea..."
    },
    "heroDescription": {
      "foo": "string"
    },
    "heroTitle": {
      "en": "Share your ideas"
    },
    "name": {
      "en": "Feature Requests",
      "es": "Solicitudes de funciones"
    },
    "submitButtonText": {
      "en": "Submit Feedback"
    }
  },
  "name": "Feature Requests",
  "object": "board",
  "postDefaults": {
    "visibility": "public"
  }
}

Returns Examples

{
  "id": "507f1f77bcf86cd799439011",
  "access": {
    "adminOnly": false,
    "allowedRoles": [
      "string"
    ],
    "deniedRoles": [
      "role_blocked"
    ],
    "segments": [
      "string"
    ]
  },
  "createdAt": "2023-12-12T00:00:00.000Z",
  "customFields": [
    "cf_priority",
    "cf_category"
  ],
  "features": {
    "commentsEnabled": true,
    "createdDatesVisible": true,
    "postingEnabled": true
  },
  "icon": {
    "type": "emoji",
    "value": "💡"
  },
  "localization": {
    "description": {
      "en": "Submit and vote on feature ideas"
    },
    "formPlaceholder": {
      "en": "Describe your feature idea..."
    },
    "heroDescription": {
      "foo": "string"
    },
    "heroTitle": {
      "en": "Share your ideas"
    },
    "name": {
      "en": "Feature Requests",
      "es": "Solicitudes de funciones"
    },
    "submitButtonText": {
      "en": "Submit Feedback"
    }
  },
  "name": "Feature Requests",
  "object": "board",
  "postDefaults": {
    "visibility": "public"
  }
}