API Style Guides

Atlassian REST API Design Guidelines

Atlassian's REST API design guidelines, applied across Jira, Confluence, Crowd, and plugin REST modules. Defines URI conventions (singular resources, versioned paths, expand/start-index/max-results query parameters), HTTP method semantics, response codes, and versioning policy.

GitHub

Other Resources

🔗
StyleGuide
https://developer.atlassian.com/server/framework/atlassian-sdk/atlassian-rest-api-design-guidelines-version-1/
🔗
Scope

Work with this as data

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"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

API entry from apis.yml

apis.yml Raw ↑ 
aid: style-guides:atlassian
name: Atlassian REST API Design Guidelines
description: Atlassian's REST API design guidelines, applied across Jira, Confluence, Crowd, and plugin
  REST modules. Defines URI conventions (singular resources, versioned paths, expand/start-index/max-results
  query parameters), HTTP method semantics, response codes, and versioning policy.
humanURL: https://developer.atlassian.com/server/framework/atlassian-sdk/atlassian-rest-api-design-guidelines-version-1/
baseURL: https://developer.atlassian.com/
tags:
- REST
- Atlassian
- Jira
- Confluence
properties:
- type: StyleGuide
  url: https://developer.atlassian.com/server/framework/atlassian-sdk/atlassian-rest-api-design-guidelines-version-1/
- type: Scope
  data:
    surfaces:
    - REST
    publisher: Atlassian
    license: documentation under Atlassian terms
    status: v1 (legacy server framework)