How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Atlassian Projects API

The Projects API from Atlassian — 22 operation(s) for projects.

Atlassian Projects API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 28 operations across 18 paths, and defines 66 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.bitbucket.org/2.0, https://your-domain.atlassian.net.

28 operations 18 paths 66 schemas 5 DELETE13 GET5 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
https://api.bitbucket.org/2.0
https://your-domain.atlassian.net
Authentication
HTTP Basic, OAuth 2.0, API Key, OAuth 2.0, HTTP Basic
Resource Areas
1

Authentication & Security 5

Atlassian Projects API declares 5 security schemes for authenticating requests. It accepts HTTP basic authentication (basic). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 24 scopes. An API key is passed in the header as Authorization (api_key). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 183 scopes. It accepts HTTP basic authentication (basicAuth).

  • basic — Basic HTTP Authentication as per [RFC-2617](https://tools.ietf.org/html/rfc2617) (Digest not supported). Note that Basic Auth is available only with username a…
  • oauth2 — OAuth 2 as per [RFC-6749](https://tools.ietf.org/html/rfc6749).
  • api_key — API Keys can be used as Basic HTTP Authentication credentials and provide a substitute for the account's actual username and password. API Keys are only availa…
  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 28

Across 18 paths, the API surfaces 28 operations — 5 DELETE, 13 GET, 5 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Projects 28

Bitbucket Cloud projects make it easier for teams to focus on a goal, product, or process by organizing their repositories.

POST
/workspaces/{workspace}/projects
Atlassian Create A Project In A Workspace
atlassianCreateAProjectInAWorkspace 1 param body → 201403404
DELETE
/workspaces/{workspace}/projects/{project_key}
Atlassian Delete A Project For A Workspace
atlassianDeleteAProjectForAWorkspace 2 params → 204403404
PUT
/workspaces/{workspace}/projects/{project_key}
Atlassian Update A Project For A Workspace
atlassianUpdateAProjectForAWorkspace 2 params body → 200201403404
GET
/workspaces/{workspace}/projects/{project_key}/default-reviewers
Atlassian List The Default Reviewers In A Project
atlassianListTheDefaultReviewersInAProject 2 params → 200403404
DELETE
/workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}
Atlassian Remove The Specific User From The Project S Default Reviewers
atlassianRemoveTheSpecificUserFromTheProjectSDefaultReviewers 3 params → 204400403404
GET
/workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}
Atlassian Get A Default Reviewer
atlassianGetADefaultReviewer 3 params → 200400403404
PUT
/workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}
Atlassian Add The Specific User As A Default Reviewer For The Project
atlassianAddTheSpecificUserAsADefaultReviewerForTheProject 3 params → 200400403404
GET
/workspaces/{workspace}/projects/{project_key}/permissions-config/groups
Atlassian List Explicit Group Permissions For A Project
atlassianListExplicitGroupPermissionsForAProject 2 params → 200401403404
DELETE
/workspaces/{workspace}/projects/{project_key}/permissions-config/groups/{group_slug}
Atlassian Delete An Explicit Group Permission For A Project
atlassianDeleteAnExplicitGroupPermissionForAProject 3 params → 204401403404
GET
/workspaces/{workspace}/projects/{project_key}/permissions-config/groups/{group_slug}
Atlassian Get An Explicit Group Permission For A Project
atlassianGetAnExplicitGroupPermissionForAProject 3 params → 200401403404
PUT
/workspaces/{workspace}/projects/{project_key}/permissions-config/groups/{group_slug}
Atlassian Update An Explicit Group Permission For A Project
atlassianUpdateAnExplicitGroupPermissionForAProject 3 params body → 200400401402403404
GET
/workspaces/{workspace}/projects/{project_key}/permissions-config/users
Atlassian List Explicit User Permissions For A Project
atlassianListExplicitUserPermissionsForAProject 2 params → 200401403404
DELETE
/workspaces/{workspace}/projects/{project_key}/permissions-config/users/{selected_user_id}
Atlassian Delete An Explicit User Permission For A Project
atlassianDeleteAnExplicitUserPermissionForAProject 3 params → 204401403404
GET
/workspaces/{workspace}/projects/{project_key}/permissions-config/users/{selected_user_id}
Atlassian Get An Explicit User Permission For A Project
atlassianGetAnExplicitUserPermissionForAProject 3 params → 200401403404
PUT
/workspaces/{workspace}/projects/{project_key}/permissions-config/users/{selected_user_id}
Atlassian Update An Explicit User Permission For A Project
atlassianUpdateAnExplicitUserPermissionForAProject 3 params body → 200400401402403404
GET
/rest/api/3/projectdeprecated
Atlassian Get All Projects
atlassianGetallprojects 3 params → 200401
POST
/rest/api/3/project
Atlassian Create Project
atlassianCreateproject body → 201400401403
GET
/rest/api/3/project/recent
Atlassian Get Recent Projects
atlassianGetrecent 2 params → 200400401
GET
/rest/api/3/project/search
Atlassian Get Projects Paginated
atlassianSearchprojects 13 params → 200400401404
DELETE
/rest/api/3/project/{projectIdOrKey}
Atlassian Delete Project
atlassianDeleteproject 2 params → 204401404
GET
/rest/api/3/project/{projectIdOrKey}
Atlassian Get Project
atlassianGetproject 3 params → 200401404
PUT
/rest/api/3/project/{projectIdOrKey}
Atlassian Update Project
atlassianUpdateproject 2 params body → 200400401403404
POST
/rest/api/3/project/{projectIdOrKey}/archive
Atlassian Archive Project
atlassianArchiveproject 1 param → 204400401403404
POST
/rest/api/3/project/{projectIdOrKey}/delete
Atlassian Delete Project Asynchronously
atlassianDeleteprojectasynchronously 1 param → 303400401404
POST
/rest/api/3/project/{projectIdOrKey}/restore
Atlassian Restore Deleted Or Archived Project
atlassianRestore 1 param → 200400401404
GET
/rest/api/3/project/{projectIdOrKey}/statuses
Atlassian Get All Statuses For Project
atlassianGetallstatuses 1 param → 200401404
GET
/rest/api/3/project/{projectId}/hierarchy
Atlassian Get Project Issue Type Hierarchy
atlassianGethierarchy 1 param → 200400401404
GET
/rest/api/3/project/{projectKeyOrId}/notificationscheme
Atlassian Get Project Notification Scheme
atlassianGetnotificationschemeforproject 2 params → 200400401404

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are Project (34 properties), Version (19 properties), CreateProjectDetails (18 properties), ProjectComponent (16 properties). Each schema is shown below with its type and property counts.

default_reviewer_and_type
object
Object containing a user that is a default reviewer and the type of reviewer
3 properties 1 required
paginated_project_group_permissions
object
A paginated list of project group permissions.
6 properties
project_group_permission
object
A group's permission for a given project.
5 properties 1 required
paginated_default_reviewer_and_type
object
A paginated list of default reviewers with reviewer type.
6 properties
group
account_links
object
Links related to an Account.
1 property
error
object
Base type for most resource objects. It defines the common type element that identifies an object's type. It also identifies the element as Swagger's discrimin…
2 properties 1 required
user_links
project
project_user_permission
object
A user's direct permission for a given project.
5 properties 1 required
link
object
A link to a resource related to this object.
2 properties
team
account
workspace
paginated_project_user_permissions
object
A paginated list of project user permissions.
6 properties
bitbucket.apps.permissions.serializers.ProjectPermissionUpdateSchema
object
1 property 1 required
object
object
Base type for most resource objects. It defines the common type element that identifies an object's type. It also identifies the element as Swagger's discrimin…
1 property 1 required
user
team_links
ProjectPermissions
object
Permissions which a user has on a project.
1 property
Scope
object
The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
2 properties
ProjectRoleUser
object
Details of the user associated with the role.
1 property
UpdatedProjectCategory
object
A project category.
4 properties
ProjectRoleGroup
object
Details of the group associated with the role.
3 properties
SimplifiedHierarchyLevel
object
9 properties
Project
object
Details about a project.
34 properties
FieldDetails
object
Details about a field.
10 properties
EventNotification
object
Details about a notification associated with an event.
10 properties
ProjectInsight
object
Additional details about a project.
2 properties
SimpleLink
object
Details about the operations available in this version.
7 properties
VersionApprover
object
Contains details about a version approver.
4 properties
PageBeanProject
object
A page of items.
7 properties
StatusDetails
object
A status.
7 properties
ProjectRole
object
Details about the roles in a project.
11 properties
CreateProjectDetails
object
Details about the project.
18 properties 2 required
NotificationSchemeEvent
object
Details about a notification scheme event.
2 properties
VersionIssuesStatus
object
Counts of the number of issues in various statuses.
4 properties
GroupName
object
Details about a group.
3 properties
TaskProgressBeanObject
object
Details about a task.
13 properties 8 required
UpdateProjectDetails
object
Details about the project.
12 properties
IssueTypeInfo
object
Details of an issue type.
3 properties
Hierarchy
object
The project issue type hierarchy.
2 properties
SimpleListWrapperGroupName
object
5 properties
ListWrapperCallbackApplicationRole
object
NotificationEvent
object
Details about a notification event.
4 properties
ProjectComponent
object
Details about a project component.
16 properties
ProjectIssueTypesHierarchyLevel
object
Details of an issue type hierarchy level.
4 properties
NotificationScheme
object
Details about a notification scheme.
8 properties
ProjectDetails
object
Details about a project.
8 properties
ApplicationRole
object
Details of an application role.
14 properties
User
object
A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: T…
14 properties
StringList
object
JsonTypeBean
object
The schema of a field.
6 properties 1 required
ProjectIdentifiers
object
Identifiers for a project.
3 properties 3 required
RoleActor
object
Details about a user assigned to a project role.
7 properties
AvatarUrlsBean
object
4 properties
ProjectCategory
object
A project category.
4 properties
StatusCategory
object
A status category.
5 properties
ListWrapperCallbackGroupName
object
ProjectLandingPageInfo
object
11 properties
SimpleListWrapperApplicationRole
object
5 properties
UserDetails
object
User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: This occurs…
10 properties
IssueTypeDetails
object
Details about an issue type.
10 properties
IssueTypeWithStatus
object
Status details for an issue type.
5 properties 5 required
Version
object
Details about a project version.
19 properties
ProjectIssueTypeHierarchy
object
The hierarchy of issue types within a project.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-projects-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

This is an independent, third-party profile of Atlassian Projects API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.