---
title: "Get all boards"
method: GET
path: "/rest/agile/1.0/board"
tags: ["Board"]
---

# Get all boards

`GET /rest/agile/1.0/board`

Returns all boards. This only includes boards that the user has permission to view.

**Deprecation notice:** The required OAuth 2.0 scopes will be updated on February 15, 2024.

 *  `read:board-scope:jira-software`, `read:project:jira`

## Query parameters

- `startAt` integer
- `maxResults` integer
- `type` object
- `name` string
- `projectKeyOrId` string
- `accountIdLocation` string
- `projectLocation` string
- `includePrivate` boolean
- `negateLocationFiltering` boolean
- `orderBy` 'name' | '-name' | '+name'
- `expand` string
- `projectTypeLocation` string[]
- `filterId` integer

## Response `200`

Returns the requested boards, at the specified page of the results.

- object
  - `isLast` boolean
  - `maxResults` integer
  - `startAt` integer
  - `total` integer
  - `values` object[]
    - `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 valid license.

---

[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)