Get all boards
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
The starting index of the returned boards. Base index: 0. See the 'Pagination' section at the top of this page for more details.
The maximum number of boards to return per page. See the 'Pagination' section at the top of this page for more details.
Filters results to boards of the specified types. Valid values: scrum, kanban, simple.
Filters results to boards that match or partially match the specified name.
Filters results to boards that are relevant to a project. Relevance means that the jql filter defined in board contains a reference to a project.
Appends private boards to the end of the list. The name and type fields are excluded for security reasons.
If set to true, negate filters used for querying by location. By default false.
Ordering of the results by a given field. If not provided, values will not be sorted. Valid values: name.
List of fields to expand for each board. Valid values: admins, permissions.
Filters results to boards that are relevant to a project types. Support Jira Software, Jira Service Management. Valid values: software, service_desk. By default software.
Filters results to boards that are relevant to a filter. Not supported for next-gen boards.
Response
Returns the requested boards, at the specified page of the results.