---
title: "Get a readable board and caller role"
method: GET
path: "/api/boards/{boardId}"
tags: ["Boards"]
---

# Get a readable board and caller role

`GET /api/boards/{boardId}`

## Request

- Base URL: `https://tre-app.com`
- URL: `https://tre-app.com/api/boards/{boardId}`
- Auth: HTTP bearer

One readable board plus the caller's own `role` on it. While the workspace is read-only — suspended by the operator, or with a trial that ran out, a canceled subscription or no plan chosen — `role` is `viewer` for every member and board writes answer 403 `Editor permissions required`. An archived board stays readable by its explicit members (`archivedAt` set) although `GET /api/boards` no longer lists it — archiving is listing, not privacy. Every board id the caller cannot read — private, archived, another workspace's, unknown — answers the one 403 `No board with this id, or you are not a member of it`, which never says whether the board exists.

## Response `200`

Success

- BoardWithRole
  - `id` string, uuid, required
  - `slug` string, required
  - `name` string, required
  - `title` string, required
  - `keyPrefix` string, required
  - `order` integer, required
  - `createdAt` string, date-time, required
  - `archivedAt` string, date-time, nullable, required
  - `backgroundKind` 'color' | 'gradient' | 'image', nullable, required
  - `backgroundValue` string, nullable, required
  - `isPrivate` boolean, required
  - `role` 'editor' | 'viewer', required

## Other responses

- `400`: Invalid request
- `401`: Unauthenticated
- `403`: Forbidden: insufficient role or token scope; scope denials name the held scope and the operation
- `404`: Not found
- `409`: Conflict
- `429`: Rate limited
- `500`: Internal server error
- `503`: Temporarily unavailable

---

[API](https://skmtc.dev/tre-app/apis/tre-rest-api.md) · [All operations](https://skmtc.dev/tre-app/apis/tre-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tre-app/apis/tre-rest-api/revisions/26a7187a05fc?raw)