API Reference

Feedback

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Boards

Boards (post categories) organize feedback into distinct containers with their own settings.

List all boards

client.feedback.boards.list(BoardListParams { featurebaseVersion } params?, RequestOptionsoptions?): BoardListResponse { id, access, createdAt, 7 more }

GET/v2/boards

Get a board by ID

client.feedback.boards.retrieve(stringid, BoardRetrieveParams { featurebaseVersion } params?, RequestOptionsoptions?): Board { id, access, createdAt, 7 more }

GET/v2/boards/{id}

ModelsExpand 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"

BoardListResponse = Array<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"