Atlassian

Atlassian is a software company that develops collaboration, productivity, and project management tools to help teams work more efficiently. Its products are designed to enhance teamwork, streamline workflows, and support project tracking across a wide range of industries.

138 APIs 16 Features

CodeCollaborationPlatformProductivitySoftware Development

APIs

Atlassian Bitbucket Addon API

The Atlassian Bitbucket Addon API allows developers to create custom add-ons and integrations for the Bitbucket platform, extending functionality with new features, tools, and s...

Atlassian Bitbucket Hook Events API

The Atlassian Bitbucket Hook Events API enables users to create webhooks in Bitbucket repositories to trigger custom actions whenever specific events occur.

Atlassian Bitbucket Pull Requests API

The Atlassian Bitbucket Pull Requests API allows users to interact with pull requests in their repositories, providing endpoints for viewing, creating, updating, and merging pul...

Atlassian Bitbucket Repositories API

The Atlassian Bitbucket Repositories API allows users to interact with and manage repositories in their Bitbucket accounts programmatically.

Atlassian Bitbucket Snippets API

The Atlassian Bitbucket Snippets API allows users to create, manage, and share code snippets within Bitbucket repositories for collaboration.

Atlassian Bitbucket Teams API

The Atlassian Bitbucket Teams API provides access to team management features including repository management, branching, and team activity.

Atlassian Bitbucket User API

The Atlassian Bitbucket User API allows developers to interact with and manage user accounts within the Bitbucket platform.

Atlassian Bitbucket Workspaces API

The Atlassian Bitbucket Workspaces API enables users to manage and interact with multiple projects within their Bitbucket account.

Atlassian Confluence Analytics API

The Atlassian Confluence Analytics API provides tools to collect, analyze, and visualize user engagement and content performance within Confluence.

Atlassian Confluence Audit API

The Atlassian Confluence Audit API provides tools to track and monitor user activity within Confluence for compliance and accountability.

Atlassian Confluence Connect App Module API

The Atlassian Confluence Connect App Module API allows developers to create custom functionalities and integrations within Confluence.

Atlassian Confluence Content API

The Atlassian Confluence Content API enables access and manipulation of content within Confluence including pages, blog posts, comments, and attachments.

Atlassian Confluence Content Body API

The Atlassian Confluence Content Body API enables programmatic manipulation of Confluence page content bodies and format conversion.

Atlassian Confluence Content States API

The Atlassian Confluence Content States API enables management and tracking of content lifecycle states within Confluence.

Atlassian Confluence Group API

The Atlassian Confluence Group API enables management of user groups within Confluence including membership and access control.

Atlassian Confluence Inline Tasks API

The Atlassian Confluence Inline Tasks API enables creating, managing, and tracking tasks directly within Confluence pages.

Atlassian Confluence Label API

The Atlassian Confluence Label API enables programmatic management of labels for categorization and organization of Confluence pages.

Atlassian Confluence Longtask API

The Atlassian Confluence Longtask API enables tracking long-running tasks within Confluence with status updates and progress monitoring.

Atlassian Confluence Relation API

The Atlassian Confluence Relation API enables creating and managing relationships between different pieces of content within Confluence.

Atlassian Confluence Search API

The Atlassian Confluence Search API enables programmatic content search within Confluence with customizable query filters.

Atlassian Confluence Settings API

The Atlassian Confluence Settings API enables customization and configuration of Confluence instance settings including themes and system information.

Atlassian Confluence Space API

The Atlassian Confluence Space API enables programmatic management of Confluence spaces including creation, permissions, and content organization.

Atlassian Confluence Template API

The Atlassian Confluence Template API enables creating and customizing templates within Confluence for standardized content creation.

Atlassian Confluence User API

The Atlassian Confluence User API enables management of user data within Confluence including profiles, groups, and permissions.

Atlassian Jira Announcement Banner API

The Atlassian Jira Announcement Banner API allows managing custom announcement banners within Jira for important messages and alerts.

Atlassian Jira App API

The Atlassian Jira App API allows developers to integrate and customize Jira with custom app properties and field values.

Atlassian Jira Application Properties API

The Atlassian Jira Application Properties API allows access and modification of Jira application configuration properties.

Atlassian Jira Application Role API

The Atlassian Jira Application Role API enables management of application roles within Jira for controlling access and permissions.

Atlassian Jira Attachment API

The Atlassian Jira Attachment API enables managing file attachments on Jira issues including upload, retrieval, and metadata.

Atlassian Jira Auditing API

The Atlassian Jira Auditing API allows tracking and monitoring all changes made within a Jira instance for compliance and accountability.

Atlassian Jira Avatar API

The Atlassian Jira Avatar API enables programmatic management of user and project avatars within Jira.

Atlassian Jira Classification Levels API

The Atlassian Jira Classification Levels API enables defining and customizing classification levels for categorizing issues.

Atlassian Jira Comment API

The Atlassian Jira Comment API enables managing comments on Jira issues including creation, updates, and property management.

Atlassian Jira Component API

The Atlassian Jira Component API allows managing project components for categorizing and organizing issues within Jira.

Atlassian Jira Configuration API

The Atlassian Jira Configuration API provides access to Jira settings and configuration options including time tracking providers.

Atlassian Jira Connect Addons API

The Atlassian Jira Connect Addons API enables building custom integrations and extensions for Jira using the Connect framework.

Atlassian Jira Connect App API

The Atlassian Jira Connect App API enables creating custom integrations between Jira and other applications using dynamic modules.

Atlassian Jira Connect Migration API

The Atlassian Jira Connect Migration API enables migrating data and configurations between Jira Cloud instances.

Atlassian Jira Connect Service Registry API

The Atlassian Jira Connect Service Registry API enables discovering and connecting services within the Jira platform.

Atlassian Jira Custom Field Option API

The Atlassian Jira Custom Field Option API enables managing custom field options for Jira issue fields.

Atlassian Jira Dashboard API

The Atlassian Jira Dashboard API enables creating, customizing, and managing dashboards and gadgets within Jira.

Atlassian Jira Data Policy API

The Atlassian Jira Data Policy API enables managing and enforcing data policies within Jira projects for compliance and governance.

Atlassian Jira Events API

The Atlassian Jira Events API enables tracking and responding to events within Jira for custom automation and notifications.

Atlassian Jira Expression API

The Atlassian Jira Expression API enables creating custom expressions for complex calculations and data operations within Jira.

Atlassian Jira Field API

The Atlassian Jira Field API enables managing custom and system fields within Jira including contexts, options, and configurations.

Atlassian Jira Field Configuration API

The Atlassian Jira Field Configuration API enables managing how fields behave and display within Jira projects.

Atlassian Jira Field Configuration Scheme API

The Atlassian Jira Field Configuration Scheme API enables defining how custom fields appear across different issue screens.

Atlassian Jira Filter API

The Atlassian Jira Filter API enables creating, managing, and sharing issue filters within Jira.

Atlassian Jira Forge App API

The Atlassian Jira Forge App API enables building custom Forge apps for Jira with serverless infrastructure.

Atlassian Jira Group API

The Atlassian Jira Group API enables managing user groups within Jira for access control and permissions.

Atlassian Jira Group User Picker API

The Atlassian Jira Group User Picker API enables searching for and selecting users within specified groups in Jira.

Atlassian Jira Groups API

The Atlassian Jira Groups API enables programmatic management of user groups and group permissions within Jira.

Atlassian Jira Issue API

The Atlassian Jira Issue API enables creating, updating, deleting, and querying issues within Jira including comments, attachments, and transitions.

Atlassian Jira Issue Link API

The Atlassian Jira Issue Link API enables creating and managing links between different issues within Jira.

Atlassian Jira Issue Link Type API

The Atlassian Jira Issue Link Type API enables managing the types of links that can be created between issues.

Atlassian Jira Issue Security Schemes API

The Atlassian Jira Issue Security Schemes API enables managing security schemes that control which users can view specific issues.

Atlassian Jira Issue Type API

The Atlassian Jira Issue Type API enables managing issue types for organizing and categorizing work within Jira.

Atlassian Jira Issue Type Scheme API

The Atlassian Jira Issue Type Scheme API enables managing and customizing issue type schemes within Jira projects.

Atlassian Jira Issue Type Screen Scheme API

The Atlassian Jira Issue Type Screen Scheme API enables customizing the screens displayed for different issue types.

Atlassian Jira Issues API

The Atlassian Jira Issues API enables bulk issue operations including archiving and exporting issues.

Atlassian Jira JQL API

The Atlassian Jira JQL API enables creating complex queries to filter, search, and retrieve specific issues from Jira.

Atlassian Jira Label API

The Atlassian Jira Label API enables managing labels for categorizing and organizing Jira issues.

Atlassian Jira License API

The Atlassian Jira License API enables managing Jira software licenses programmatically.

Atlassian Jira License Metrics API

The Atlassian Jira License Metrics API provides access to license usage metrics for Jira instances.

Atlassian Jira My Permissions API

The Atlassian Jira My Permissions API enables viewing the current user's permission levels within Jira.

Atlassian Jira My Preferences API

The Atlassian Jira My Preferences API enables managing personal user preferences within Jira.

Atlassian Jira Myself API

The Atlassian Jira Myself API enables accessing and updating the current user's own profile and account information.

Atlassian Jira Notification Scheme API

The Atlassian Jira Notification Scheme API enables managing notification schemes for Jira projects.

Atlassian Jira Permission Scheme API

The Atlassian Jira Permission Scheme API enables creating and managing permission schemes for controlling access within Jira.

Atlassian Jira Permissions API

The Atlassian Jira Permissions API enables checking and managing permissions for users and groups within Jira.

Atlassian Jira Priority API

The Atlassian Jira Priority API enables managing issue priority levels within Jira.

Atlassian Jira Project API

The Atlassian Jira Project API enables creating, managing, and configuring projects within Jira including roles and permissions.

Atlassian Jira Project Category API

The Atlassian Jira Project Category API enables managing project categories for organizing projects within Jira.

Atlassian Jira Project Validate API

The Atlassian Jira Project Validate API enables validating project keys and names before creation.

Atlassian Jira Resolution API

The Atlassian Jira Resolution API enables managing issue resolution types within Jira.

Atlassian Jira Role API

The Atlassian Jira Role API enables managing project roles and role actors within Jira.

Atlassian Jira Screens API

The Atlassian Jira Screens API enables creating and managing issue screens, tabs, and field layouts within Jira.

Atlassian Jira Screen Scheme API

The Atlassian Jira Screen Scheme API enables managing screen schemes that define default screens for issue operations.

Atlassian Jira Search API

The Atlassian Jira Search API enables searching for issues using JQL queries and filters.

Atlassian Jira Security Level API

The Atlassian Jira Security Level API enables managing issue security levels for controlling access to specific issues.

Atlassian Jira Server Info API

The Atlassian Jira Server Info API provides information about the Jira server including version and build details.

Atlassian Jira Settings API

The Atlassian Jira Settings API enables managing Jira instance settings including issue navigator columns.

Atlassian Jira Status API

The Atlassian Jira Status API enables retrieving workflow status information for Jira issues.

Atlassian Jira Status Category API

The Atlassian Jira Status Category API enables accessing and managing workflow status categories within Jira.

Atlassian Jira Statuses API

The Atlassian Jira Statuses API enables paginated search and management of workflow statuses within Jira.

Atlassian Jira Task API

The Atlassian Jira Task API enables managing and tracking long-running tasks within Jira.

Atlassian Jira UI Modifications API

The Atlassian Jira UI Modifications API enables customizing and enhancing the Jira user interface for apps.

Atlassian Jira Universal Avatar API

The Atlassian Jira Universal Avatar API enables managing avatars across different entity types within Jira.

Atlassian Jira User API

The Atlassian Jira User API enables managing user accounts, properties, and permissions within Jira.

Atlassian Jira Users API

The Atlassian Jira Users API enables searching and managing multiple users within Jira.

Atlassian Jira Version API

The Atlassian Jira Version API enables managing project versions and releases within Jira.

Atlassian Jira Webhook API

The Atlassian Jira Webhook API enables managing webhooks for receiving real-time notifications about Jira events.

Atlassian Jira Workflow API

The Atlassian Jira Workflow API enables managing workflows, transitions, and workflow rules within Jira.

Atlassian Jira Workflow Scheme API

The Atlassian Jira Workflow Scheme API enables managing workflow schemes and mapping workflows to issue types.

Atlassian Jira Workflows API

The Atlassian Jira Workflows API enables bulk workflow operations including creation, validation, and capability checking.

Atlassian Jira Worklog API

The Atlassian Jira Worklog API enables managing time tracking worklogs on Jira issues.

Atlassian Jira Software Backlog API

The Atlassian Jira Software Backlog API enables managing backlog items within Jira Software boards.

Atlassian Jira Software Board API

The Atlassian Jira Software Board API enables managing Scrum and Kanban boards within Jira Software.

Atlassian Jira Software Epic API

The Atlassian Jira Software Epic API enables managing epics in Jira Software for organizing large bodies of work.

Atlassian Jira Software Sprint API

The Atlassian Jira Software Sprint API enables managing sprints within Jira Software Scrum boards.

Atlassian Jira Software Development Information API

The Atlassian Jira Software Development Information API enables sending development data like commits, branches, and pull requests to Jira.

Atlassian Jira Software Feature Flags API

The Atlassian Jira Software Feature Flags API enables sending feature flag information to Jira Software for release coordination.

Atlassian Jira Software Deployments API

The Atlassian Jira Software Deployments API enables sending deployment information to Jira Software for CI/CD visibility.

Atlassian Jira Software Builds API

The Atlassian Jira Software Builds API enables sending build information to Jira Software for CI/CD visibility.

Atlassian Jira Software Remote Links API

The Atlassian Jira Software Remote Links API enables connecting Jira issues to external resources and tools.

Atlassian Jira Software Security Information API

The Atlassian Jira Software Security Information API enables sending vulnerability information to Jira for security tracking.

Atlassian Jira Service Management Customer API

The Atlassian Jira Service Management Customer API enables managing customer accounts and access to service desks.

Atlassian Jira Service Management Info API

The Atlassian Jira Service Management Info API provides runtime and version information about the JSM instance.

Atlassian Jira Service Management Knowledgebase API

The Atlassian Jira Service Management Knowledgebase API enables searching knowledge base articles for resolving customer requests.

Atlassian Jira Service Management Organization API

The Atlassian Jira Service Management Organization API enables managing organizations for grouping customers within JSM.

Atlassian Jira Service Management Request API

The Atlassian Jira Service Management Request API enables creating and managing service requests within JSM.

Atlassian Jira Service Management Request Type API

The Atlassian Jira Service Management Request Type API enables managing request types within JSM service desks.

Atlassian Jira Service Management Servicedesk API

The Atlassian Jira Service Management Servicedesk API enables managing service desks, queues, and configurations within JSM.

Atlassian Jira Service Management Assets API

The Atlassian Jira Service Management Assets API enables managing IT assets and CMDB within JSM.

Atlassian Bitbucket Branch Restrictions API

The Atlassian Bitbucket Branch Restrictions API enables managing branch restrictions for repositories in Bitbucket Cloud.

Atlassian Bitbucket Branching Model API

The Atlassian Bitbucket Branching Model API enables managing branching model configurations for repositories.

Atlassian Bitbucket Commit Statuses API

The Atlassian Bitbucket Commit Statuses API enables managing build statuses associated with commits.

Atlassian Bitbucket Commits API

The Atlassian Bitbucket Commits API enables interacting with commits in Bitbucket Cloud repositories.

Atlassian Bitbucket Deployments API

The Atlassian Bitbucket Deployments API enables managing deployment information for Bitbucket Cloud repositories.

Atlassian Bitbucket Downloads API

The Atlassian Bitbucket Downloads API enables managing download artifacts for Bitbucket Cloud repositories.

Atlassian Bitbucket Pipelines API

The Atlassian Bitbucket Pipelines API enables managing Bitbucket Pipelines CI/CD configurations and builds.

Atlassian Bitbucket Projects API

The Atlassian Bitbucket Projects API enables managing projects for grouping related repositories within workspaces.

Atlassian Bitbucket Refs API

The Atlassian Bitbucket Refs API enables managing branches and tags within Bitbucket Cloud repositories.

Atlassian Bitbucket Source API

The Atlassian Bitbucket Source API enables browsing and retrieving source code files from Bitbucket repositories.

Atlassian Bitbucket Issue Tracker API

The Atlassian Bitbucket Issue Tracker API enables managing the built-in issue tracker within Bitbucket repositories.

Atlassian Bitbucket Reports API

The Atlassian Bitbucket Reports API enables creating code insight reports with annotations for commits.

Atlassian Bitbucket SSH API

The Atlassian Bitbucket SSH API enables managing SSH keys for secure Git operations in Bitbucket Cloud.

Atlassian Trello API

The Atlassian Trello API enables programmatic interaction with Trello boards, cards, lists, and other resources.

Atlassian Compass API

The Atlassian Compass API enables interacting with the Compass developer experience platform for managing software component health.

Atlassian Statuspage API

The Atlassian Statuspage API enables programmatic management of status pages, components, incidents, and subscribers.

Atlassian Admin Organizations API

The Atlassian Admin Organizations API enables managing Atlassian organizations, user access, and organization-level settings.

Atlassian Admin User Management API

The Atlassian Admin User Management API enables managing user accounts and profiles across an Atlassian organization.

Atlassian Admin User Provisioning API

The Atlassian Admin User Provisioning API enables SCIM-based automated user and group provisioning between identity providers and Atlassian Cloud.

Atlassian Forge Platform REST API

The Atlassian Forge Platform REST API provides programmatic access to the Forge serverless cloud app development platform.

Atlassian Jira Service Management Operations Alerts API

The Atlassian Jira Service Management Operations Alerts API enables managing alerts for proactive incident management within JSM.

Atlassian Jira Service Management Operations Incidents API

The Atlassian Jira Service Management Operations Incidents API enables managing incident lifecycle operations within JSM.

Atlassian Incidents REST API

The Atlassian Incidents REST API enables managing major incidents across Atlassian products.

Atlassian Forge App REST API

The Atlassian Forge App REST API enables Forge apps to expose custom REST API endpoints for external system integration.

Agent Skills

forge-app-builder

AGENT SKILL

forge-app-review

AGENT SKILL

forge-connector

AGENT SKILL

forge-debugger

AGENT SKILL

ARAZZO

GraphQL

Atlassian GraphQL API

GRAPHQL

Pricing Plans

Atlassian Plans Pricing

4 plans

PLANS

Rate Limits

Atlassian Rate Limits

3 limits

RATE LIMITS

FinOps

Atlassian Finops

FINOPS

Features

Jira (Software, Work Mgmt, Service Mgmt) per-user pricing

Confluence per-user pricing

Bitbucket Cloud per-user pricing

Trello free + paid tiers

Jira Product Discovery, Jira Align (separate)

Most products: Free up to 10 users (5 for Bitbucket)

Standard tiers: Jira ~$9, Confluence ~$6, Bitbucket $3.65, JSM ~$23 per user/mo

Premium adds Atlassian Intelligence, advanced features, 99.9% SLA

Enterprise: 99.95% uptime, data residency, centralized security

REST API at api.atlassian.com (per-product paths)

GraphQL API (for some products)

Per-app per-user rate limit ~10 req/sec

OAuth 2.0 (3LO), API tokens, OAuth client credentials

Atlassian Connect framework for marketplace apps

Forge for serverless app dev

Atlassian Marketplace ecosystem

Use Cases

Agile Software Development

Plan, track, and release software using Scrum and Kanban workflows with Jira Software boards and sprints.

DevOps and CI/CD

Automate build, test, and deployment pipelines using Bitbucket Pipelines integrated with Jira for end-to-end traceability.

IT Service Management

Manage IT service requests, incidents, problems, and changes using Jira Service Management with SLA tracking.

Knowledge Management

Create and organize team documentation, runbooks, and knowledge bases using Confluence spaces and templates.

Enterprise Administration

Manage organization-wide user provisioning, access policies, and product licenses across Atlassian Cloud products.

Incident Management

Detect, respond to, and resolve major incidents with JSM operations alerts, on-call schedules, and postmortem tracking.

Integrations

Slack

Real-time notifications and two-way integration between Atlassian products and Slack channels for team communication.

Microsoft Teams

Integration with Microsoft Teams for Jira and Confluence notifications, issue creation, and collaboration.

GitHub

Connect GitHub repositories to Jira for linking commits, branches, and pull requests to Jira issues.

GitLab

Integration with GitLab for development information visibility within Jira issues.

VS Code

Official Atlassian VS Code extension for Jira issue management and Bitbucket code reviews from the IDE.

Jenkins

Connect Jenkins CI/CD pipelines to Jira for build and deployment visibility on issues.

Terraform

Terraform provider for managing Atlassian Operations resources as infrastructure-as-code.

Opsgenie

Incident management and on-call alerting integration now part of Jira Service Management Operations.

Kubernetes

Data Center Helm charts for deploying Atlassian products on Kubernetes clusters.

Backstage

0 classes · 10 properties

JSON-LD

API Governance Rules

Atlassian API Rules

7 rules · 7 errors

1 properties

JSON STRUCTURE

Atlassian Structure

0 properties

EXAMPLE

Atlassian Bitbucket Pull Requests A_Pullrequest_Task_Create Example

2 fields

6 fields

EXAMPLE

Atlassian Bitbucket Pull Requests Paginated_Pullrequests Example

6 fields

EXAMPLE

Atlassian Bitbucket Pull Requests Paginated_Tasks Example

6 fields

EXAMPLE

Atlassian Bitbucket Pull Requests Participant Example

EXAMPLE

Atlassian Bitbucket Pull Requests Pullrequest Example

EXAMPLE

1 fields

Atlassian Bitbucket Repositories Effective_Repo_Branching_Model Example

EXAMPLE

Atlassian Bitbucket Repositories Error Example

2 fields

EXAMPLE

Atlassian Bitbucket Repositories Export_Options Example

5 fields

EXAMPLE

Atlassian Bitbucket Repositories Group Example

EXAMPLE

Atlassian Bitbucket Repositories Issue Example

EXAMPLE

Atlassian Bitbucket Repositories Issue_Attachment Example

EXAMPLE

Atlassian Bitbucket Repositories Issue_Change Example

6 fields

EXAMPLE

Atlassian Bitbucket Repositories Issue_Comment Example

EXAMPLE

Atlassian Bitbucket Repositories Issue_Job_Status Example

6 fields

EXAMPLE

Atlassian Bitbucket Repositories Link Example

2 fields

EXAMPLE

EXAMPLE

Atlassian Bitbucket Repositories Pipeline Example

EXAMPLE

Atlassian Bitbucket Repositories Pipeline_Build_Number Example

EXAMPLE

Atlassian Bitbucket Repositories Pipeline_Cache Example

EXAMPLE

Atlassian Bitbucket Repositories Pipeline_Cache_Content_Uri Example

1 fields

EXAMPLE

Atlassian Bitbucket Repositories Pipeline_Command Example

2 fields

EXAMPLE

Atlassian Bitbucket Repositories Pipeline_Image Example

4 fields

2 fields

EXAMPLE

Atlassian Bitbucket Repositories Pullrequest_Merge_Parameters Example

4 fields

EXAMPLE

Atlassian Bitbucket Repositories Ref Example

3 fields

EXAMPLE

Atlassian Bitbucket Repositories Report Example

EXAMPLE

Atlassian Bitbucket Repositories Report_Annotation Example

EXAMPLE

Atlassian Bitbucket Repositories Report_Data Example

3 fields

EXAMPLE

Atlassian Bitbucket Repositories Repository Example

EXAMPLE

Atlassian Bitbucket Repositories Repository_Group_Permission Example

3 fields

EXAMPLE

Atlassian Bitbucket Repositories Repository_Inheritance_State Example

2 fields

EXAMPLE

Atlassian Bitbucket Repositories Repository_Permission Example

2 fields

EXAMPLE

Atlassian Bitbucket Repositories Repository_User_Permission Example

3 fields

EXAMPLE

Atlassian Bitbucket Repositories Tag Example

EXAMPLE

Atlassian Bitbucket Repositories Task Example

7 fields

EXAMPLE

Atlassian Bitbucket Repositories Team Example

EXAMPLE

Atlassian Bitbucket Repositories Team_Links Example

EXAMPLE

Atlassian Bitbucket Repositories Treeentry Example

2 fields

4 fields

EXAMPLE

Atlassian Bitbucket Teams Error Example

2 fields

EXAMPLE

Atlassian Bitbucket Teams Link Example

2 fields

EXAMPLE

Atlassian Bitbucket Teams Object Example

1 fields

EXAMPLE

Atlassian Bitbucket Teams Paginated_Pipeline_Variables Example

6 fields

EXAMPLE

Atlassian Bitbucket Teams Participant Example

EXAMPLE

Atlassian Bitbucket Teams Pipeline_Variable Example

EXAMPLE

Atlassian Bitbucket Teams Project Example

EXAMPLE

Atlassian Bitbucket Teams Ref Example

3 fields

EXAMPLE

Atlassian Bitbucket User Author Example

EXAMPLE

Atlassian Bitbucket User Base_Commit Example

EXAMPLE

Atlassian Bitbucket User Branch Example

EXAMPLE

6 fields

EXAMPLE

Atlassian Bitbucket User Participant Example

EXAMPLE

Atlassian Bitbucket User Pipeline_Variable Example

EXAMPLE

Atlassian Bitbucket User Project Example

EXAMPLE

Atlassian Bitbucket User Project_User_Permission Example

3 fields

EXAMPLE

Atlassian Bitbucket User Ref Example

3 fields

EXAMPLE

Atlassian Bitbucket Workspaces Default_Reviewer_And_Type Example

2 fields

EXAMPLE

Atlassian Bitbucket Workspaces Error Example

2 fields

EXAMPLE

Atlassian Bitbucket Workspaces Project_User_Permission Example

3 fields

EXAMPLE

2 fields

2 fields

EXAMPLE

4 fields

EXAMPLE

Atlassian Confluence Content Content Id Example

EXAMPLE

Atlassian Confluence Content Embedded Content Example

2 fields

8 fields

EXAMPLE

Atlassian Confluence Settings Look And Feel Selection Example

2 fields

EXAMPLE

Atlassian Confluence Settings Look And Feel Settings Example

1 fields

EXAMPLE

10 fields

EXAMPLE

6 fields

EXAMPLE

Visuals

View API subway map

Resources

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Atlassian Confluence User API
  version: 1.0.0
items:
- info:
    name: Users
    type: folder
  items:
  - info:
      name: Atlassian Get Anonymous User
      type: http
    http:
      method: GET
      url: //your-domain.atlassian.net/wiki/rest/api/user/anonymous
      params:
      - name: expand
        value: ''
        type: query
        description: "A multi-value parameter indicating which properties of the user to\nexpand.\n\n  - `operations` returns\
          \ the operations that the user is allowed to do."
    docs: Returns information about how anonymous users are represented, like the<br>profile picture and display name.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw)
      required**:<br>Permission to access the Confluence site ('Can use' global permission).
  - info:
      name: Atlassian Get Current User
      type: http
    http:
      method: GET
      url: //your-domain.atlassian.net/wiki/rest/api/user/current
      params:
      - name: expand
        value: ''
        type: query
        description: "A multi-value parameter indicating which properties of the user to\nexpand.\n\n  - `operations` returns\
          \ the operations that the user is allowed to do.\n  - `personalSpace` returns the user's personal space, if it exists.\n\
          \  - `isExternalCollaborator` returns whether the user is an external collaborator user."
    docs: Returns the currently logged-in user. This includes information about<br>the user, like the display name, userKey,
      account ID, profile picture,<br>and more.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>Permission
      to access the Confluence site ('Can use' global permission).
  - info:
      name: Atlassian Get Group Memberships for User
      type: http
    http:
      method: GET
      url: //your-domain.atlassian.net/wiki/rest/api/user/memberof
      params:
      - name: accountId
        value: ''
        type: query
        description: 'The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.

          For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.'
      - name: start
        value: ''
        type: query
        description: The starting index of the returned groups.
      - name: limit
        value: ''
        type: query
        description: 'The maximum number of groups to return per page.

          Note, this may be restricted by fixed system limits.'
    docs: Returns the groups that a user is a member of.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw)
      required**:<br>Permission to access the Confluence site ('Can use' global permission).
  - info:
      name: Atlassian Get Multiple Users Using Ids
      type: http
    http:
      method: GET
      url: //your-domain.atlassian.net/wiki/rest/api/user/bulk
      params:
      - name: accountId
        value: ''
        type: query
        description: A list of accountId's of users to be returned.
      - name: expand
        value: ''
        type: query
        description: "A multi-value parameter indicating which properties of the user to\nexpand.\n\n  - `operations` returns\
          \ the operations that the user is allowed to do.\n  - `personalSpace` returns the user's personal space, if it exists.\n\
          \  - `isExternalCollaborator` returns whether the user is an external collaborator user."
      - name: limit
        value: ''
        type: query
        description: 'The maximum number of results returned.

          Currently API returns 200 results max.

          If more that 200 ids are passed first 200 will be returned.'
    docs: Returns user details for the ids provided in request.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw)
      required**:<br>Permission to access the Confluence site ('Can use' global permission).
  - info:
      name: Atlassian Get User Email Address
      type: http
    http:
      method: GET
      url: //your-domain.atlassian.net/wiki/rest/api/user/email
      params:
      - name: accountId
        value: ''
        type: query
        description: 'The account ID of the user, which uniquely identifies the user across all Atlassian products.

          For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. Required.'
    docs: Returns a user's email address. This API is only available to apps approved by<br>Atlassian, according to these
      [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw)
      required**:<br>Permission to access the Confluence site ('Can use' global permission).
  - info:
      name: Atlassian Get User Email Addresses in Batch
      type: http
    http:
      method: GET
      url: //your-domain.atlassian.net/wiki/rest/api/user/email/bulk
      params:
      - name: accountId
        value: ''
        type: query
        description: The account IDs of the users.
    docs: Returns user email addresses for a set of accountIds. This API is only available to apps approved by<br>Atlassian,
      according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).<br><br>Any
      accounts which are not available will not be included in the result.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw)
      required**:<br>Permission to access the Confluence site ('Can use' global permission).
- info:
    name: Content Watches
    type: folder
  items:
  - info:
      name: Atlassian Get Content Watch Status
      type: http
    http:
      method: GET
      url: //your-domain.atlassian.net/wiki/rest/api/user/watch/content/:contentId
      params:
      - name: contentId
        value: ''
        type: path
        description: 'The ID of the content to be queried for whether the specified user is

          watching it.'
    docs: 'Returns whether a user is watching a piece of content. Choose the user by<br>doing one of the following:<br><br>-
      Specify a user via a query parameter: Use the `accountId` to identify the user.<br>- Do not specify a user: The currently
      logged-in user will be used.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>''Confluence
      Administrator'' global permission if specifying a user, otherwise<br>permission to access the Confluence site (''Can
      use'' global permission).'
  - info:
      name: Atlassian Add Content Watcher
      type: http
    http:
      method: POST
      url: //your-domain.atlassian.net/wiki/rest/api/user/watch/content/:contentId
      params:
      - name: contentId
        value: ''
        type: path
        description: The ID of the content to add the watcher to.
    docs: 'Adds a user as a watcher to a piece of content. Choose the user by doing<br>one of the following:<br><br>- Specify
      a user via a query parameter: Use the `accountId` to identify the user.<br>- Do not specify a user: The currently logged-in
      user will be used.<br><br>Note, you must add the `X-Atlassian-Token: no-check` header when making a<br>request, as this
      operation has XSRF protection.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>''Confluence
      Administrator'' gl'
  - info:
      name: Atlassian Remove Content Watcher
      type: http
    http:
      method: DELETE
      url: //your-domain.atlassian.net/wiki/rest/api/user/watch/content/:contentId
      headers:
      - name: X-Atlassian-Token
        value: ''
      params:
      - name: contentId
        value: ''
        type: path
        description: The ID of the content to remove the watcher from.
    docs: 'Removes a user as a watcher from a piece of content. Choose the user by<br>doing one of the following:<br><br>-
      Specify a user via a query parameter: Use the `accountId` to identify the user.<br>- Do not specify a user: The currently
      logged-in user will be used.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>''Confluence
      Administrator'' global permission if specifying a user, otherwise<br>permission to access the Confluence site (''Can
      use'' global permission).'
  - info:
      name: Atlassian Get Label Watch Status
      type: http
    http:
      method: GET
      url: //your-domain.atlassian.net/wiki/rest/api/user/watch/label/:labelName
      params:
      - name: labelName
        value: ''
        type: path
        description: 'The name of the label to be queried for whether the specified user is

          watching it.'
    docs: 'Returns whether a user is watching a label. Choose the user by doing one<br>of the following:<br><br>- Specify
      a user via a query parameter: Use the `accountId` to identify the user.<br>- Do not specify a user: The currently logged-in
      user will be used.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>''Confluence Administrator''
      global permission if specifying a user, otherwise<br>permission to access the Confluence site (''Can use'' global permission).'
  - info:
      name: Atlassian Add Label Watcher
      type: http
    http:
      method: POST
      url: //your-domain.atlassian.net/wiki/rest/api/user/watch/label/:labelName
      headers:
      - name: X-Atlassian-Token
        value: ''
      params:
      - name: labelName
        value: ''
        type: path
        description: The name of the label to add the watcher to.
    docs: 'Adds a user as a watcher to a label. Choose the user by doing one of the<br>following:<br><br>- Specify a user
      via a query parameter: Use the `accountId` to identify the user.<br>- Do not specify a user: The currently logged-in
      user will be used.<br><br>Note, you must add the `X-Atlassian-Token: no-check` header when making a<br>request, as this
      operation has XSRF protection.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>''Confluence
      Administrator'' global permis'
  - info:
      name: Atlassian Remove Label Watcher
      type: http
    http:
      method: DELETE
      url: //your-domain.atlassian.net/wiki/rest/api/user/watch/label/:labelName
      params:
      - name: labelName
        value: ''
        type: path
        description: The name of the label to remove the watcher from.
    docs: 'Removes a user as a watcher from a label. Choose the user by doing one of<br>the following:<br><br>- Specify a
      user via a query parameter: Use the `accountId` to identify the user.<br>- Do not specify a user: The currently logged-in
      user will be used.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>''Confluence Administrator''
      global permission if specifying a user, otherwise<br>permission to access the Confluence site (''Can use'' global permission).'
  - info:
      name: Atlassian Get Space Watch Status
      type: http
    http:
      method: GET
      url: //your-domain.atlassian.net/wiki/rest/api/user/watch/space/:spaceKey
      params:
      - name: spaceKey
        value: ''
        type: path
        description: 'The key of the space to be queried for whether the specified user is

          watching it.'
    docs: 'Returns whether a user is watching a space. Choose the user by<br>doing one of the following:<br><br>- Specify
      a user via a query parameter: Use the `accountId` to identify the user.<br>- Do not specify a user: The currently logged-in
      user will be used.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>''Confluence Administrator''
      global permission if specifying a user, otherwise<br>permission to access the Confluence site (''Can use'' global permission).'
  - info:
      name: Atlassian Add Space Watcher
      type: http
    http:
      method: POST
      url: //your-domain.atlassian.net/wiki/rest/api/user/watch/space/:spaceKey
      headers:
      - name: X-Atlassian-Token
        value: ''
      params:
      - name: spaceKey
        value: ''
        type: path
        description: The key of the space to add the watcher to.
    docs: 'Adds a user as a watcher to a space. Choose the user by doing one of the<br>following:<br><br>- Specify a user
      via a query parameter: Use the `accountId` to identify the user.<br>- Do not specify a user: The currently logged-in
      user will be used.<br><br>Note, you must add the `X-Atlassian-Token: no-check` header when making a<br>request, as this
      operation has XSRF protection.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>''Confluence
      Administrator'' global permis'
  - info:
      name: Atlassian Remove Space Watch
      type: http
    http:
      method: DELETE
      url: //your-domain.atlassian.net/wiki/rest/api/user/watch/space/:spaceKey
      params:
      - name: spaceKey
        value: ''
        type: path
        description: The key of the space to remove the watcher from.
    docs: 'Removes a user as a watcher from a space. Choose the user by doing one of<br>the following:<br><br>- Specify a
      user via a query parameter: Use the `accountId` to identify the user.<br>- Do not specify a user: The currently logged-in
      user will be used.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:<br>''Confluence Administrator''
      global permission if specifying a user, otherwise<br>permission to access the Confluence site (''Can use'' global permission).'
- info:
    name: User Properties
    type: folder
  items:
  - info:
      name: Atlassian Get User Properties
      type: http
    http:
      method: GET
      url: //your-domain.atlassian.net/wiki/rest/api/user/:userId/property
      params:
      - name: userId
        value: ''
        type: path
        description: The account ID of the user to be queried for its properties.
      - name: start
        value: ''
        type: query
        description: The starting index of the returned properties.
      - name: limit
        value: ''
        type: query
        description: 'The maximum number of properties to return per page.

          Note, this may be restricted by fixed system limits.'
    docs: Returns the properties for a user as list of property keys. For more information<br>about user properties, see [Confluence
      entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).<br>`Note`, these
      properties stored against a user are on a Confluence site level and not space/content level.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw)
      required**:<br>Permission to access the Confluence site ('Can use' global permission).
  - info:
      name: Atlassian Get User Property
      type: http
    http:
      method: GET
      url: //your-domain.atlassian.net/wiki/rest/api/user/:userId/property/:key
      params:
      - name: userId
        value: ''
        type: path
        description: The account ID of the user to be queried for its properties.
      - name: key
        value: ''
        type: path
        description: The key of the user property.
    docs: Returns the property corresponding to `key` for a user. For more information<br>about user properties, see [Confluence
      entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).<br>`Note`, these
      properties stored against a user are on a Confluence site level and not space/content level.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw)
      required**:<br>Permission to access the Confluence site ('Can use' global permission).
  - info:
      name: Atlassian Create User Property by Key
      type: http
    http:
      method: POST
      url: //your-domain.atlassian.net/wiki/rest/api/user/:userId/property/:key
      params:
      - name: userId
        value: ''
        type: path
        description: 'The account ID of the user. The accountId uniquely identifies the user across all Atlassian

          products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192'
      - name: key
        value: ''
        type: path
        description: The key of the user property.
      body:
        type: json
        data: '{}'
    docs: Creates a property for a user. For more information  about user properties, see [Confluence entity properties]<br>(https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).<br>`Note`,
      these properties stored against a user are on a Confluence site level and not space/content level.<br><br>`Note:` the
      number of properties which could be created per app in a tenant for each user might be<br>restricted by fixed system
      limits.<br>**[Permissions](https://confluence.atlassian.co
  - info:
      name: Atlassian Update User Property
      type: http
    http:
      method: PUT
      url: //your-domain.atlassian.net/wiki/rest/api/user/:userId/property/:key
      params:
      - name: userId
        value: ''
        type: path
        description: 'The account ID of the user. The accountId uniquely identifies the user across all Atlassian

          products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192'
      - name: key
        value: ''
        type: path
        description: The key of the user property.
      body:
        type: json
        data: '{}'
    docs: 'Updates a property for the given user. Note, you cannot update the key of a user property, only the value.<br>For
      more information about user properties, see<br>[Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).<br>`Note`,
      these properties stored against a user are on a Confluence site level and not space/content level.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw)
      required**:<br>Permission to access the Confluence '
  - info:
      name: Atlassian Delete User Property
      type: http
    http:
      method: DELETE
      url: //your-domain.atlassian.net/wiki/rest/api/user/:userId/property/:key
      params:
      - name: userId
        value: ''
        type: path
        description: 'The account ID of the user. The accountId uniquely identifies the user across all Atlassian

          products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192'
      - name: key
        value: ''
        type: path
        description: The key of the user property.
    docs: Deletes a property for the given user.<br>For more information about user properties, see<br>[Confluence entity
      properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).<br>`Note`, these properties
      stored against a user are on a Confluence site level and not space/content level.<br><br>**[Permissions](https://confluence.atlassian.com/x/_AozKw)
      required**:<br>Permission to access the Confluence site ('Can use' global permission).
bundled: true