---
title: "Create board"
method: POST
path: "/rest/agile/1.0/board"
tags: ["Board"]
---

# Create board

`POST /rest/agile/1.0/board`

Creates a new board. Board name, type and filter ID is required.

 *  `name` \- Must be less than 255 characters.
 *  `type` \- Valid values: scrum, kanban
 *  `filterId` \- ID of a filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects' permission and tries to create a shared board, a private board will be created instead (remember that board sharing depends on the filter sharing).
 *  `location` \- The container that the board will be located in. `location` must include the `type` property (Valid values: project, user). If choosing 'project', then a project must be specified by a `projectKeyOrId` property in `location`. If choosing 'user', the current user is chosen by default. The `projectKeyOrId` property should not be provided.

Note:

 *  If you want to create a new project with an associated board, use the [Jira platform REST API](https://docs.atlassian.com/jira/REST/latest). For more information, see the [Create project](#api-rest-api-3-project-post) method. The `projectTypeKey` for software boards must be 'software' and the `projectTemplateKey` must be either `com.pyxis.greenhopper.jira:gh-kanban-template` or `com.pyxis.greenhopper.jira:gh-scrum-template`.
 *  You can create a filter using the [Jira REST API](https://docs.atlassian.com/jira/REST/latest). For more information, see the [Create filter](#api-rest-api-3-filter-post) method.
 *  If you do not ORDER BY the Rank field for the filter of your board, you will not be able to reorder issues on the board.

## Request body

- object
  - `filterId` integer
  - `location` object
    - `projectKeyOrId` string
    - `type` 'project' | 'user'
  - `name` string
  - `type` 'kanban' | 'scrum' | 'agility'

## Response `201`

Returns the created 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.

---

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