---
title: "List users who can open a board"
method: GET
path: "/api/board/{boardId}/users"
tags: ["Board"]
---

# List users who can open a board

`GET /api/board/{boardId}/users`

## Request

- Base URL: `https://core-api.getaptly.com`
- URL: `https://core-api.getaptly.com/api/board/{boardId}/users`
- Auth: one of:
  - API key in header `x-token`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/getaptly/apis/aptly-api/docs/api/board/:boardId/users/get.ts> (a function with typed inputs; its response is checked against the schema)

The company's users who can open this board, for assignee pickers. Access comes
from a direct share, a share to one of the user's teams, or — for non-guest users —
the board not being private. `canEdit` is true when that access includes editing.
Unlike `configuration/shares`, this resolves teams and public access into users and
accepts a delegate token with a boards read scope.

## Path parameters

- `boardId` string, required

## Response `200`

Users with access to the board.

- object
  - `data` object[]
    - `_id` string
    - `name` string
    - `role` string, nullable
    - `canEdit` boolean

## Other responses

- `401`: Invalid or missing credential.
- `403`: The credential cannot read this board.
- `404`: Board not found.

---

[API](https://skmtc.dev/getaptly/apis/aptly-api.md) - [All operations](https://skmtc.dev/getaptly/apis/aptly-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getaptly/apis/aptly-api/revisions/75c367e0b8e5?raw)