List boards the caller is a member of

GET

/boards

const url = 'https://projects.work.optidata.cloud/api/boards';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://projects.work.optidata.cloud/api/boards \
  --header 'Authorization: Bearer <token>'

Returns every board the authenticated user is a member of, as a flat array. When board_id is given, that board and all of its descendants are excluded from the result (useful to pick a new parent for a board without creating a cycle).

Authorizations

bearerAuth

Parameters

Query Parameters

board_id

integer

Exclude this board and all of its descendant boards from the result. Must reference an existing board.

Responses

200

Boards the user belongs to.

application/json

Array<object>

A project (kanban board). Boards nest via parent_id.

object

integer

user_id

Owner user id.

integer | null

group_id

integer | null

cuid

Tenant/company identifier the board belongs to.

string

parent_id

Parent board id (null for root boards).

integer | null

name

string

<= 80 characters

description

string | null

<= 600 characters

icon

Emoji icon.

string | null

visibility

string

Allowed values: private public

order_cards_by

Default card sort field for new columns.

string | null

order_cards_direction

string | null

Allowed values: asc desc

archived_at

string | null format: date-time

created_at

string format: date-time

updated_at

string format: date-time

deleted_at

string | null format: date-time

Example

[
  {
    "id": 42,
    "user_id": 7,
    "group_id": null,
    "cuid": "a1b2c3d4-0000-4111-8222-333344445555",
    "name": "Website Redesign",
    "description": "Q3 marketing site refresh",
    "icon": "🎨",
    "parent_id": null,
    "archived_at": null,
    "visibility": "private",
    "order_cards_by": "order",
    "order_cards_direction": "asc",
    "created_at": "2026-03-10T17:09:05.000000Z",
    "updated_at": "2026-03-10T17:09:05.000000Z",
    "deleted_at": null
  }
]

401

Missing, invalid or expired bearer passport.

application/json

object

error

string

Example

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

The authenticated user lacks the required board permission.

application/json

object

message

string

Example

{
  "message": "This action is unauthorized."
}