---
title: "List boards"
method: GET
path: "/boards"
---

# List boards

`GET /boards`

## Request

- Base URL: `https://clusters.soleilpictures.com/api/v1`
- URL: `https://clusters.soleilpictures.com/api/v1/boards`
- Auth: HTTP bearer

## Query parameters

- `workspace` string, uuid
- `parent` string
- `deleted` '1' | 'true'
- `limit` integer
- `offset` integer

## Response `200`

A page of boards

- object
  - `boards` object[]
    - `id` string, uuid
    - `name` string
    - `workspace_id` string, uuid
    - `parent_board_id` string, uuid, nullable
    - `view` 'canvas' | 'list'
    - `deleted` boolean
    - `created_at` string, date-time
    - `updated_at` string, date-time, nullable
    - `scheduled_date` string, date, nullable: The calendar date this board sits on, if any.
    - `scheduled_end` string, date, nullable: Inclusive end of a multi-day block. Null for a single day.
    - `day_label` string, nullable: The durable half of a scheduled day's name, e.g. "Day 12". The date is never stored in the name.
    - `sched_status` 'draft' | 'published' | 'cancelled'
    - `sched_version` integer: Bumped on publish. Only a published board notifies its readers when it moves.
    - `sched_published_at` string, date-time, nullable
  - `limit` integer
  - `offset` integer
  - `has_more` boolean
  - `next_offset` integer, nullable

---

[API](https://skmtc.dev/soleilpictures/apis/soleil-clusters-api.md) · [All operations](https://skmtc.dev/soleilpictures/apis/soleil-clusters-api/llms.txt) · [OpenAPI document](https://skmtc.dev/soleilpictures/apis/soleil-clusters-api/revisions/1d426d587bf3?raw)