GET /rest/api/2/statuses/search

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

Permissions required:

Servers

Query parameters

Name Type Required Description
projectId String No

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

startAt Integer No

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

Default value: 0

maxResults Integer No

The maximum number of items to return per page.

Default value: 200

searchString String No

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

expand String No

Deprecated. See the deprecation notice for details.

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.
statusCategory String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.