---
title: "Get board access settings"
method: GET
path: "/api/board/{boardId}/configuration/shares"
tags: ["Board"]
---

# Get board access settings

`GET /api/board/{boardId}/configuration/shares`

## Request

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

Returns the board's access type and ACL (shares array).

## Path parameters

- `boardId` string, required

## Response `200`

Board access settings.

- object
  - `data` object
    - `accessType` 'public' | 'private'
    - `acl` object[]
      - `_id` string
      - `userId` string
      - `teamId` string
      - `permissions` string[]

## Other responses

- `401`: Invalid or missing API key.
- `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)