Status

Search statuses paginated

Changed on

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

Permissions required:

get/rest/api/3/statuses/search

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/statuses/search
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: manage:jira-configuration

Query parameters

projectIdstring

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

startAtinteger

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

maxResultsinteger

The maximum number of items to return per page.

searchStringstring

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

statusCategorystring

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

includeGlobalStatusesboolean

Whether to include global statuses (scope = null, not tied to any project) in the response. Defaults to false. Only relevant for project scoped queries.

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring

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

selfstring

The URL of this page.

startAtinteger

The index of the first item returned on the page.

totalinteger

Number of items that satisfy the search.

Changes

  • 23cd462c2497Revision changes
    • info

      added the new optional query request parameter includeGlobalStatuses

  • 10c4041677d4Revision changes
    • warning

      deleted the query request parameter expand

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status