Boards

Boards are containers for grouping related ideas. These endpoints return active, non-archived boards for your company.

List boards

GET /api/v1/boards/

Retrieve a paginated list of boards.

Query parameters

Parameter	Type	Required	Default	Description
`limit`	integer	No	20	Results per page (max 100).
`offset`	integer	No	0	Number of results to skip.

Example request

curl -sS \
  -H 'Authorization: Api-Key scalar*live*...' \
  'https://<your-host>/api/v1/boards/'

Success response (200 OK)

{
    "results": [
        {
            "id": 1,
            "title": "Feedback",
            "description": "General product feedback",
            "colour": "#8B5CF6",
            "is_private": false,
            "is_archived": false,
            "show_on_roadmap": true,
            "allow_posts": true,
            "allow_notes": true,
            "approve_posts": false,
            "slug": "feedback-abc123",
            "order": 1,
            "idea_count": 42
        }
    ],
    "count": 1
}

Objects

Board object

Field	Type	Description
`id`	integer	Unique internal ID.
`title`	string	Board title.
`description`	string	Board description.
`colour`	string	Hex display colour.
`is_private`	boolean	Whether the board is internal-only.
`is_archived`	boolean	Whether the board is archived.
`show_on_roadmap`	boolean	Whether ideas from this board appear on the roadmap.
`allow_posts`	boolean	Whether new ideas can be submitted to this board.
`allow_notes`	boolean	Whether comments are enabled on ideas in this board.
`approve_posts`	boolean	Whether new ideas require approval before publishing.
`slug`	string	URL-safe identifier.
`order`	integer	Display order in the dashboard.
`idea_count`	integer	Number of active ideas in this board.