Search statuses paginated

Returns a paginated list of statuses that match a search on name or project.

Permissions required:

Administer projects project permission.

{"self":"https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=0&maxResults=2","nextPage":"https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=2&maxResults=2","maxResults":2,"startAt":0,"total":5,"isLast":true,"values":[{"id":"1000","name":"Finished","statusCategory":"DONE","scope":{"type":"PROJECT","project":{"id":"1"}},"description":"The issue is resolved","usages":[{"project":{"id":"1"},"issueTypes":["10002"]}],"workflowUsages":[{"workflowName":"Workflow 1","workflowId":"545d80a3-91ff-4949-8b0d-a2bc484e70e5"}]}]}

Request

Query Params

expand

string

optional

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

usages Returns the project and issue types that use the status in their workflow.

workflowUsages Returns the workflows that use the status.

projectId

string

optional

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

startAt

integer

optional

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

maxResults

integer

optional

The maximum number of items to return per page.

searchString

string

optional

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

statusCategory

string

optional

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

Responses

🟢200Returned if the request is successful.

application/json

Body

isLast

boolean

optional

Whether this is the last page.

maxResults

integer <int32>

optional

The maximum number of items that could be returned.

string

optional

The URL of the next page of results, if any.

self

string

optional

The URL of this page.

startAt

integer <int64>

optional

The index of the first item returned on the page.

total

integer <int64>

optional

Number of items that satisfy the search.

values

array[object (JiraStatus) {7}]

optional

The list of items.

description

string

optional

The description of the status.

string

optional

The ID of the status.

name

string

optional

The name of the status.

scope

object (StatusScope)

optional

The scope of the status.

statusCategory

enum<string>

optional

The category of the status.

Allowed values:

TODOIN_PROGRESSDONE

usages

array[object (ProjectIssueTypes) {2}]

optional

Projects and issue types where the status is used. Only available if the usages expand is requested.

workflowUsages

array[object (WorkflowUsages) {2}]

optional

The workflows that use this status. Only available if the workflowUsages expand is requested.

🟠400Returned if the request is not valid.

🟠401Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation.