Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

How to fetch the filter used in a Board using REST API

Ann Mary Thomas (RBEI/ETB41) October 3, 2025

I want to fetch the filter used in a board within a Project using REST API which can be used in Forge App.

I have already tried the following, which are either deprecatd or cant be accessed using Forge app

1.`/rest/agile/1.0/board/{boardId}/configuration

2. /rest/agile/1.0/board/${boardId}/filter

3 answers

0 votes
Jayesh
Contributor
October 5, 2025

Hello @Ann Mary Thomas (RBEI/ETB41) 

You can achieve the solution in 2 steps

1) Get the Filter id from board configuration

2) Use Jira Platform API to fetch the filter the JQL is using

In this way you can achieve the neccesaary output.


Thanks
Jayesh R

Ann Mary Thomas (RBEI/ETB41) October 5, 2025

1)/rest/agile/1.0/board/${boardId}/filter). I got error 

For this scope read:jira-board was added, However it returned error - Invalid 'scopes' permission in the manifest.yml file - 'read:jira-board'.

0 votes
Sunny Ape
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
October 3, 2025

Hello @Ann Mary Thomas (RBEI/ETB41) 

I have already tried the following, which are either deprecatd or cant be accessed using Forge app

The endpoint to use is the first one, Get Configuration. That endpoint returns a filter object with the id of the filter. That endpoint absolutely is not deprecated and it absolutely can be accessed from a Forge app.

If you are having problems with interacting with that API endpoint in your Forge app, then I recommend that you provide a detailed explanation of the problem, including code samples and error logs, in the Forge section of the Developer's Community forum.

I also recommend that you use an API test tool like Postman to confirm the functionality of endpoints, or to determine if they have been deprecated or not.

Ann Mary Thomas (RBEI/ETB41) October 5, 2025

const response = await requestJira(/rest/agile/1.0/board/{boardId}/configuration, {
Problem
Permission - read : jira-board
Invalid scopes permission in manifest -'read:jira-board'

0 votes
Bill Sheboy
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
October 3, 2025

Hi @Ann Mary Thomas (RBEI/ETB41) 

First, I have not tried that with a Forge app.

After a quick search in the developer community, I found these related diagnostic steps to help get a board endpoint to work:

https://community.developer.atlassian.com/t/error-using-the-get-all-boards-rest-api-on-forge/95779

 

Kind regards,
Bill

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
ENTERPRISE
PERMISSIONS LEVEL
Product Admin
TAGS
AUG Leaders

Atlassian Community Events