---
title: "Get board"
method: GET
path: "/rest/agile/1.0/board/{boardId}"
tags: ["Board"]
---

# Get board

`GET /rest/agile/1.0/board/{boardId}`

Returns the board for the given board ID. This board will only be returned if the user has permission to view it. Admins without the view permission will see the board as a private one, so will see only a subset of the board's data (board location for instance).

## Path parameters

- `boardId` integer, required

## Response `200`

Returns the requested board.

- object — Details about a board.
  - `admins` object — The users and groups who own the board.
    - `groups` object[]
      - `name` string
      - `self` string, uri
    - `users` object[]
      - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
      - `active` boolean — Whether the user is active.
      - `avatarUrls` object — The avatars of the user.
        - `16x16` string, uri — The URL of the user's 16x16 pixel avatar.
        - `24x24` string, uri — The URL of the user's 24x24 pixel avatar.
        - `32x32` string, uri — The URL of the user's 32x32 pixel avatar.
        - `48x48` string, uri — The URL of the user's 48x48 pixel avatar.
      - `displayName` string — The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
      - `key` string — This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The key of the user.
      - `name` string — This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The username of the user.
      - `self` string, uri — The URL of the user.
  - `canEdit` boolean — Whether the board can be edited.
  - `favourite` boolean — Whether the board is selected as a favorite.
  - `id` integer — The ID of the board.
  - `isPrivate` boolean — Whether the board is private.
  - `location` object — The container that the board is located in.
    - `avatarURI` string, uri
    - `displayName` string
    - `name` string
    - `projectId` integer
    - `projectKey` string
    - `projectName` string
    - `projectTypeKey` string
    - `userAccountId` string
    - `userId` integer
  - `name` string — The name of the board.
  - `self` string, uri — The URL of the board.
  - `type` string — The type the board.

## Other responses

- `400` — Returned if the request is invalid.
- `401` — Returned if the user is not logged in.
- `403` — Returned if the user does not have a valid license.
- `404` — Returned if the board does not exist or the user does not have permission to view it.

---

[API](https://skmtc.net/atlassian/apis/jira-software-cloud-api.md) · [All operations](https://skmtc.net/atlassian/apis/jira-software-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/jira-software-cloud-api/versions/4e108d54b990/schema)