Search statuses paginated · The Jira Cloud platform REST API

provider Status GET /rest/api/3/statuses/search

@utdk/jira /rest/api/3/statuses/search

Search statuses paginated

Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of statuses that match a search on name or project. **[Permissions](#permissions) required:** * *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg) * *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg)

projectId query: The project the status is part of or null for global statuses.; string
startAt query: The index of the first item to return in a page of results (page offset).; integer
maxResults query: The maximum number of items to return per page.; integer
searchString query: Term to match status names against or null to search for all statuses in the search scope.; string
statusCategory query: Category of the status to filter by. The supported values are: `TODO`, `IN_PROGRESS`, and `DONE`.; string

Try it

Authentication

Configure credentials for The Jira Cloud platform REST API

Gateway

The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Execution Mode

Gateway URL

Saved automatically to browser storage.

GET/rest/api/3/statuses/search

projectId

The project the status is part of or null for global statuses.

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

searchString

Term to match status names against or null to search for all statuses in the search scope.

statusCategory

Category of the status to filter by. The supported values are: `TODO`, `IN_PROGRESS`, and `DONE`.

Enter a gateway URL above to enable sending.

Code snippet

Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.search({
  "startAt": 0,
  "maxResults": 200
})