Endpoint
List boards visible to the current organization member. Results can be filtered by gateway or board group and are paginated using limit/offset parameters.
Query Parameters
Filter boards by gateway ID. Only returns boards associated with the specified gateway.
Filter boards by board group ID. Only returns boards that belong to the specified group.
Maximum number of boards to return per page.
Number of boards to skip before starting to return results.
Response
Returns a paginated list of boards sorted alphabetically by name (case-insensitive), then by creation date (descending).
Array of board objectsUnique identifier for the board
Organization that owns this board
Display name of the board
Detailed description of the board’s purpose
Gateway associated with this board
Board group this board belongs to, if any
Type of board (e.g., “goal”)
Primary objective for goal boards
Key-value pairs defining success criteria
Target completion date in ISO 8601 format
Whether the goal has been confirmed
Source or origin of the goal
require_approval_for_done
Whether tasks require approval before marking as done
require_review_before_done
Whether tasks require review before completion
block_status_changes_with_pending_approval
Whether status changes are blocked when approval is pending
only_lead_can_change_status
Whether only the board lead can change task status
Maximum number of agents allowed on this board
When the board was created (ISO 8601 format)
When the board was last updated (ISO 8601 format)
Total number of boards matching the filter criteria
Maximum number of items per page
Example Request
curl -X GET "https://api.example.com/api/v1/boards?gateway_id=550e8400-e29b-41d4-a716-446655440000&limit=20" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Example Response
{
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"organization_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Q1 Product Launch",
"slug": "q1-product-launch",
"description": "Launch new product features for Q1 2026",
"gateway_id": "550e8400-e29b-41d4-a716-446655440000",
"board_group_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"board_type": "goal",
"objective": "Successfully launch product with 95% uptime",
"success_metrics": {
"uptime": "95%",
"user_satisfaction": "4.5/5"
},
"target_date": "2026-03-31T23:59:59Z",
"goal_confirmed": true,
"goal_source": "Product roadmap Q1 2026",
"require_approval_for_done": true,
"require_review_before_done": false,
"block_status_changes_with_pending_approval": false,
"only_lead_can_change_status": false,
"max_agents": 3,
"created_at": "2026-01-15T10:30:00Z",
"updated_at": "2026-02-20T14:45:00Z"
}
],
"total": 1,
"limit": 20,
"offset": 0
}
Authorization
Requires organization member authentication. Users can only see boards they have read access to based on their organization membership.