Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/atlassian:atlassian-status-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
contact:
email: ecosystem@atlassian.com
description: Jira Cloud platform REST API documentation
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
termsOfService: http://atlassian.com/terms/
title: Atlassian The Jira Cloud platform REST Status API
version: 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
servers:
- url: https://your-domain.atlassian.net
tags:
- name: Status
paths:
/rest/api/3/statuses:
delete:
deprecated: false
description: 'Deletes statuses by ID.
**Permissions required:**
* *Administer projects* project permission.
* *Administer Jira* project permission.'
operationId: atlassianDeletestatusesbyid
parameters:
- description: 'The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
Min items `1`, Max items `50`'
in: query
name: id
required: true
schema:
items:
type: string
type: array
responses:
'204':
content:
application/json:
schema: {}
description: Returned if the request is successful.
'400':
content:
application/json:
example: '{"errorMessages":["The name is too long, maxSize=255"],"errors":{}}'
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Bulk Delete Statuses
tags:
- Status
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- write:workflow:jira
state: Beta
x-atlassian-connect-scope: ADMIN
get:
deprecated: false
description: 'Returns a list of the statuses specified by one or more status IDs.
**Permissions required:**
* *Administer projects* project permission.
* *Administer Jira* project permission.'
operationId: atlassianGetstatusesbyid
parameters:
- description: "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `usages` Returns the project and issue types that use the status in their workflow.\n * `workflowUsages` Returns the workflows that use the status."
in: query
name: expand
schema:
type: string
- description: 'The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
Min items `1`, Max items `50`'
in: query
name: id
required: true
schema:
items:
type: string
type: array
responses:
'200':
content:
application/json:
example: '[{"description":"The issue is resolved","id":"1000","name":"Finished","scope":{"project":{"id":"1"},"type":"PROJECT"},"statusCategory":"DONE","usages":[{"issueTypes":["10002"],"project":{"id":"1"}}],"workflowUsages":[{"workflowId":"545d80a3-91ff-4949-8b0d-a2bc484e70e5","workflowName":"Workflow 1"}]}]'
schema:
items:
$ref: '#/components/schemas/JiraStatus'
type: array
description: Returned if the request is successful.
'400':
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Bulk Get Statuses
tags:
- Status
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- read:workflow:jira
state: Beta
x-atlassian-connect-scope: READ
post:
deprecated: false
description: 'Creates statuses for a global or project scope.
**Permissions required:**
* *Administer projects* project permission.
* *Administer Jira* project permission.'
operationId: atlassianCreatestatuses
parameters: []
requestBody:
content:
application/json:
example:
scope:
project:
id: '1'
type: PROJECT
statuses:
- description: The issue is resolved
name: Finished
statusCategory: DONE
schema:
$ref: '#/components/schemas/StatusCreateRequest'
description: Details of the statuses being created and their scope.
required: true
responses:
'200':
content:
application/json:
example: '[{"description":"The issue is resolved","id":"1000","name":"Finished","scope":{"project":{"id":"1"},"type":"PROJECT"},"statusCategory":"DONE","usages":[],"workflowUsages":[]}]'
schema:
items:
$ref: '#/components/schemas/JiraStatus'
type: array
description: Returned if the request is successful.
'400':
content:
application/json:
example: '{"errorMessages":["The name is too long, maxSize=255"],"errors":{}}'
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation.
'409':
description: Returned if another workflow configuration update task is ongoing.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Bulk Create Statuses
tags:
- Status
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- write:workflow:jira
state: Beta
x-atlassian-connect-scope: ADMIN
put:
deprecated: false
description: 'Updates statuses by ID.
**Permissions required:**
* *Administer projects* project permission.
* *Administer Jira* project permission.'
operationId: atlassianUpdatestatuses
parameters: []
requestBody:
content:
application/json:
example:
statuses:
- description: The issue is resolved
id: '1000'
name: Finished
statusCategory: DONE
schema:
$ref: '#/components/schemas/StatusUpdateRequest'
description: The list of statuses that will be updated.
required: true
responses:
'204':
content:
application/json:
schema: {}
description: Returned if the request is successful.
'400':
content:
application/json:
example: '{"errorMessages":["The name is too long, maxSize=255"],"errors":{}}'
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation.
'409':
description: Returned if another workflow configuration update task is ongoing.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Bulk Update Statuses
tags:
- Status
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- write:workflow:jira
state: Beta
x-atlassian-connect-scope: ADMIN
/rest/api/3/statuses/search:
get:
deprecated: false
description: 'Returns a paginated list of statuses that match a search on name or project.
**Permissions required:**
* *Administer projects* project permission.
* *Administer Jira* project permission.'
operationId: atlassianSearch
parameters:
- description: "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `usages` Returns the project and issue types that use the status in their workflow.\n * `workflowUsages` Returns the workflows that use the status."
in: query
name: expand
schema:
type: string
- description: The project the status is part of or null for global statuses.
in: query
name: projectId
schema:
type: string
- description: The index of the first item to return in a page of results (page offset).
in: query
name: startAt
schema:
default: 0
format: int64
type: integer
- description: The maximum number of items to return per page.
in: query
name: maxResults
schema:
default: 200
format: int32
type: integer
- description: Term to match status names against or null to search for all statuses in the search scope.
in: query
name: searchString
schema:
maxLength: 255
type: string
- description: 'Category of the status to filter by. The supported values are: `TODO`, `IN_PROGRESS`, and `DONE`.'
in: query
name: statusCategory
schema:
type: string
responses:
'200':
content:
application/json:
example: '{"isLast":true,"maxResults":2,"nextPage":"https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=2&maxResults=2","self":"https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=0&maxResults=2","startAt":0,"total":5,"values":[{"description":"The issue is resolved","id":"1000","name":"Finished","scope":{"project":{"id":"1"},"type":"PROJECT"},"statusCategory":"DONE","usages":[{"issueTypes":["10002"],"project":{"id":"1"}}],"workflowUsages":[{"workflowId":"545d80a3-91ff-4949-8b0d-a2bc484e70e5","workflowName":"Workflow 1"}]}]}'
schema:
$ref: '#/components/schemas/PageOfStatuses'
description: Returned if the request is successful.
'400':
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Search Statuses Paginated
tags:
- Status
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- read:workflow:jira
state: Beta
x-atlassian-connect-scope: READ
components:
schemas:
StatusCreate:
additionalProperties: false
description: Details of the status being created.
properties:
description:
description: The description of the status.
type: string
name:
description: The name of the status.
maxLength: 255
type: string
statusCategory:
description: The category of the status.
enum:
- TODO
- IN_PROGRESS
- DONE
type: string
required:
- name
- statusCategory
type: object
WorkflowUsages:
additionalProperties: false
description: The workflows that use this status. Only available if the `workflowUsages` expand is requested.
properties:
workflowId:
description: Workflow ID.
type: string
workflowName:
description: Workflow name.
type: string
type: object
ProjectId:
additionalProperties: false
description: Project ID details.
properties:
id:
description: The ID of the project.
type: string
required:
- id
type:
- object
- 'null'
StatusUpdate:
additionalProperties: true
description: Details of the status being updated.
properties:
description:
description: The description of the status.
type: string
id:
description: The ID of the status.
type: string
name:
description: The name of the status.
type: string
statusCategory:
description: The category of the status.
enum:
- TODO
- IN_PROGRESS
- DONE
type: string
required:
- id
- name
- statusCategory
type: object
PageOfStatuses:
additionalProperties: false
properties:
isLast:
description: Whether this is the last page.
type: boolean
maxResults:
description: The maximum number of items that could be returned.
format: int32
type: integer
nextPage:
description: The URL of the next page of results, if any.
type: string
self:
description: The URL of this page.
type: string
startAt:
description: The index of the first item returned on the page.
format: int64
type: integer
total:
description: Number of items that satisfy the search.
format: int64
type: integer
values:
description: The list of items.
items:
$ref: '#/components/schemas/JiraStatus'
type: array
type: object
ProjectIssueTypes:
additionalProperties: false
description: Use the optional `workflows.usages` expand to get additional information about the projects and issue types associated with the requested workflows.
properties:
issueTypes:
description: IDs of the issue types
items:
description: IDs of the issue types
type:
- string
- 'null'
type:
- array
- 'null'
uniqueItems: true
project:
$ref: '#/components/schemas/ProjectId'
type: object
StatusCreateRequest:
additionalProperties: false
description: Details of the statuses being created and their scope.
properties:
scope:
$ref: '#/components/schemas/StatusScope'
statuses:
description: Details of the statuses being created.
items:
$ref: '#/components/schemas/StatusCreate'
type: array
required:
- scope
- statuses
type: object
JiraStatus:
additionalProperties: false
description: Details of a status.
properties:
description:
description: The description of the status.
type: string
id:
description: The ID of the status.
type: string
name:
description: The name of the status.
type: string
scope:
$ref: '#/components/schemas/StatusScope'
statusCategory:
description: The category of the status.
enum:
- TODO
- IN_PROGRESS
- DONE
type: string
usages:
description: Projects and issue types where the status is used. Only available if the `usages` expand is requested.
items:
$ref: '#/components/schemas/ProjectIssueTypes'
type: array
uniqueItems: true
workflowUsages:
description: The workflows that use this status. Only available if the `workflowUsages` expand is requested.
items:
$ref: '#/components/schemas/WorkflowUsages'
type: array
uniqueItems: true
type: object
StatusUpdateRequest:
additionalProperties: false
description: The list of statuses that will be updated.
properties:
statuses:
description: The list of statuses that will be updated.
items:
$ref: '#/components/schemas/StatusUpdate'
type: array
required:
- statuses
type: object
StatusScope:
additionalProperties: false
description: The scope of the status.
properties:
project:
$ref: '#/components/schemas/ProjectId'
type:
description: The scope of the status. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects.
enum:
- PROJECT
- GLOBAL
type: string
required:
- type
type: object
securitySchemes:
OAuth2:
description: OAuth2 scopes for Jira
flows:
authorizationCode:
authorizationUrl: https://auth.atlassian.com/authorize
scopes:
delete:async-task:jira: Delete asynchronous task.
delete:attachment:jira: Delete issue attachments.
delete:avatar:jira: Delete system and custom avatars.
delete:comment.property:jira: Delete issue comment properties.
delete:comment:jira: Delete issue comments.
delete:dashboard.property:jira: Delete dashboard properties.
delete:dashboard:jira: Delete dashboards.
delete:field-configuration-scheme:jira: Delete field configuration schemes.
delete:field-configuration:jira: Delete field configurations.
delete:field.option:jira: Delete field options.
delete:field:jira: Delete fields.
delete:filter.column:jira: Delete filter columns.
delete:filter:jira: Delete filters.
delete:group:jira: Delete user groups.
delete:issue-link-type:jira: Delete issue link types.
delete:issue-link:jira: Delete issue links.
delete:issue-type-scheme:jira: Delete issue type schemes.
delete:issue-type-screen-scheme:jira: Delete issue type screen schemes.
delete:issue-type.property:jira: Delete issue type properties.
delete:issue-type:jira: Delete issue types.
delete:issue-worklog.property:jira: Delete issue worklog properties.
delete:issue-worklog:jira: Delete issue worklogs.
delete:issue.property:jira: Delete issue properties.
delete:issue.remote-link:jira: Delete issue remote links.
delete:issue:jira: Delete issues.
delete:permission-scheme:jira: Delete permission schemes.
delete:permission:jira: Delete permissions.
delete:project-category:jira: Delete project categories.
delete:project-role:jira: Delete project roles.
delete:project-version:jira: Delete project versions.
delete:project.avatar:jira: Delete project avatars.
delete:project.component:jira: Delete project components.
delete:project.property:jira: Delete project properties.
delete:project:jira: Delete projects and their details, such as issue types, project lead, and avatars.
delete:screen-scheme:jira: Delete screen schemes.
delete:screen-tab:jira: Delete screen tabs.
delete:screen:jira: Delete screens.
delete:screenable-field:jira: Delete screenable fields.
delete:user-configuration:jira: Delete user configurations.
delete:user.property:jira: Delete user properties.
delete:webhook:jira: Delete webhooks.
delete:workflow-scheme:jira: Delete workflow schemes.
delete:workflow.property:jira: Delete workflow properties.
delete:workflow:jira: Delete workflows.
manage:jira-configuration: Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types.
manage:jira-project: Create and edit project settings and create new project-level objects, for example, versions, components.
manage:jira-webhook: Manage Jira webhooks. Enables an OAuth app to register and unregister dynamic webhooks in Jira. It also provides for fetching of registered webhooks.
read:application-role:jira: View application roles.
read:attachment:jira: View issue attachments.
read:audit-log:jira: View audit logs.
read:avatar:jira: View system and custom avatars.
read:comment.property:jira: View issue comment properties.
read:comment:jira: View issue comments.
read:custom-field-contextual-configuration:jira: Read custom field contextual configurations.
read:dashboard.property:jira: View dashboard properties.
read:dashboard:jira: View dashboards.
read:field-configuration-scheme:jira: View field configuration schemes.
read:field-configuration:jira: Read field configurations.
read:field.default-value:jira: View field default values.
read:field.option:jira: View field options.
read:field.options:jira: Read field options.
read:field:jira: View fields.
read:filter.column:jira: View filter columns.
read:filter.default-share-scope:jira: View filter default share scopes.
read:filter:jira: View filters.
read:group:jira: View user groups.
read:instance-configuration:jira: View instance configurations.
read:issue-details:jira: View issue details.
read:issue-event:jira: Read issue events.
read:issue-field-values:jira: View issue field valueses.
read:issue-link-type:jira: View issue link types.
read:issue-link:jira: View issue links.
read:issue-meta:jira: View issue meta.
read:issue-security-level:jira: View issue security levels.
read:issue-security-scheme:jira: View issue security schemes.
read:issue-status:jira: View issue statuses.
read:issue-type-hierarchy:jira: Read issue type hierarchies.
read:issue-type-scheme:jira: View issue type schemes.
read:issue-type-screen-scheme:jira: View issue type screen schemes.
read:issue-type.property:jira: View issue type properties.
read:issue-type:jira: View issue types.
read:issue-worklog.property:jira: View issue worklog properties.
read:issue-worklog:jira: View issue worklogs.
read:issue.changelog:jira: View issue changelogs.
read:issue.property:jira: View issue properties.
read:issue.remote-link:jira: View issue remote links.
read:issue.time-tracking:jira: View issue time trackings.
read:issue.transition:jira: View issue transitions.
read:issue.vote:jira: View issue votes.
read:issue.votes:jira: View issue voteses.
read:issue.watcher:jira: View issue watchers.
read:issue:jira: View issues.
read:jira-expressions:jira: View jira expressions.
read:jira-user: View user information in Jira that you have access to, including usernames, email addresses, and avatars.
read:jira-work: Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs).
read:jql:jira: View JQL.
read:label:jira: View labels.
read:license:jira: View licenses.
read:notification-scheme:jira: View notification schemes.
read:permission-scheme:jira: View permission schemes.
read:permission:jira: View permissions.
read:priority:jira: View priorities.
read:project-category:jira: View project categories.
read:project-role:jira: View project roles.
read:project-type:jira: View project types.
read:project-version:jira: View project versions.
read:project.avatar:jira: Read project avatars.
read:project.component:jira: View project components.
read:project.email:jira: View project emails.
read:project.feature:jira: Read project features.
read:project.property:jira: View project properties.
read:project:jira: View projects.
read:resolution:jira: View resolutions.
read:role:jira: View roles.
read:screen-field:jira: View screen fields.
read:screen-scheme:jira: View screen schemes.
read:screen-tab:jira: View screen tabs.
read:screen:jira: View screens.
read:screenable-field:jira: View screenable fields.
read:status:jira: View statuses.
read:user-configuration:jira: View user configurations.
read:user.columns:jira: View user columnses.
read:user.property:jira: View user properties.
read:user:jira: View users.
read:webhook:jira: View webhooks.
read:workflow-scheme:jira: View workflow schemes.
read:workflow.property:jira: View workflow properties.
read:workflow:jira: View workflows.
send:notification:jira: Send notifications.
validate:jql:jira: Validate JQL.
write:attachment:jira: Create and update issue attachments.
write:avatar:jira: Create and update system and custom avatars.
write:comment.property:jira: Create and update issue comment properties.
write:comment:jira: Create and update issue comments.
write:custom-field-contextual-configuration:jira: Save custom field contextual configurations.
write:dashboard.property:jira: Create and update dashboard properties.
write:dashboard:jira: Create and update dashboards.
write:field-configuration-scheme:jira: Create and update field configuration schemes.
write:field-configuration:jira: Save field configurations.
write:field.default-value:jira: Create and update field default values.
write:field.option:jira: Create and update field options.
write:field:jira: Create and update fields.
write:filter.column:jira: Create and update filter columns.
write:filter.default-share-scope:jira: Create and update filter default share scopes.
write:filter:jira: Create and update filters.
write:group:jira: Create and update user groups.
write:instance-configuration:jira: Create and update instance configurations.
write:issue-link-type:jira: Create and update issue link types.
write:issue-link:jira: Create and update issue links.
write:issue-type-scheme:jira: Create and update issue type schemes.
write:issue-type-screen-scheme:jira: Create and update issue type screen schemes.
write:issue-type.property:jira: Create and update issue type properties.
write:issue-type:jira: Create and update issue types.
write:issue-worklog.property:jira: Create and update issue worklog properties.
write:issue-worklog:jira: Create and update issue worklogs.
write:issue.property:jira: Create and update issue properties.
write:issue.remote-link:jira: Create and update issue remote links.
write:issue.time-tracking:jira: Create and update issue time trackings.
write:issue.vote:jira: Create and update issue votes.
write:issue.watcher:jira: Create and update issue watchers.
write:issue:jira: Create and update issues.
write:jira-work: Create and edit issues in Jira, post comments, create worklogs, and delete issues.
write:permission-scheme:jira: Create and update permission schemes.
write:permission:jira: Create and update permissions.
write:project-category:jira: Create and update project categories.
write:project-role:jira: Create and update project roles.
write:project-version:jira: Create and update project versions.
write:project.avatar:jira: Create and update project avatars.
write:project.component:jira: Create and update project components.
write:project.email:jira: Create and update project emails.
write:project.feature:jira: Save project features.
write:project.property:jira: Create and update project properties.
write:project:jira: Create and update projects.
write:screen-scheme:jira: Create and update screen schemes.
write:screen-tab:jira: Create and update screen tabs.
write:screen:jira: Create and update screens.
write:screenable-field:jira: Create and update screenable fields.
write:user-configuration:jira: Create and update user configurations.
write:user.property:jira: Create and update user properties.
write:webhook:jira: Create and update webhooks.
write:workflow-scheme:jira: Create and update workflow schemes.
write:workflow.property:jira: Create and update workflow properties.
write:workflow:jira: Create and update workflows.
tokenUrl: https://auth.atlassian.com/oauth/token
type: oauth2
basicAuth:
description: You can access this resource via basic auth.
scheme: basic
type: http
externalDocs:
description: Find out more about Atlassian products and services.
url: http://www.atlassian.com
x-atlassian-narrative:
documents:
- anchor: about
body: "The Jira REST API enables you to interact with Jira programmatically. Use this API to \n[build apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/), script interactions with \nJira, or develop any other type of integration. This page documents the REST resources available in Jira Cloud, including \nthe HTTP response codes and example requests and responses."
title: About
- anchor: version
body: "This documentation is for **version 3** of the Jira Cloud platform REST API, which is the latest version\nbut is in **beta**. [Version 2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/) and \nversion 3 of the API offer the same collection of operations. However, version 3 provides support for \nthe [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/) \n(ADF) in: \n- `body` in comments, including where comments are used in issue, issue link, and transition resources.\n- `comment` in worklogs.\n- `description` and `environment` fields in issues.\n- `textarea` type custom fields (multi-line text fields) in issues. Single line custom fields \n (`textfield`) accept a string and don't handle Atlassian Document Format content.\n\nHowever, these new features are under development and may change.\n"
title: Version
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://artifacts.apis.io/atlassian/openapi/atlassian-status-api-openapi.yml