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

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)