Projects

Get all projects

Changed on

Returns all projects visible to the user. Deprecated, use Get projects paginated that supports search and pagination.

This operation can be accessed anonymously.

Permissions required: Projects are returned only where the user has Browse Projects or Administer projects project permission for the project.

get/rest/api/2/project

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/project
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: read:jira-work)
    • none

Query parameters

expandstring

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:

  • description Returns the project description.
  • issueTypes Returns all issue types associated with the project.
  • lead Returns information about the project lead.
  • projectKeys Returns all project keys associated with the project.
recentinteger

Returns the user's most recently accessed projects. You may specify the number of results to return up to a maximum of 20. If access is anonymous, then the recently accessed projects are based on the current HTTP session.

propertiesstring[]

A list of project properties to return for the project. This parameter accepts a comma-separated list.

Response

Returned if the request is successful.

archivedboolean

Whether the project is archived.

archivedDatestring date-time

The date when the project was archived.

assigneeType'PROJECT_LEAD' | 'UNASSIGNED'

The default assignee when creating issues for this project.

deletedboolean

Whether the project is marked as deleted.

deletedDatestring date-time

The date when the project was marked as deleted.

descriptionstring

A brief description of the project.

emailstring

An email address associated with the project.

expandstring

Expand options that include additional project details in the response.

favouriteboolean

Whether the project is selected as a favorite.

idstring

The ID of the project.

isPrivateboolean

Whether the project is private from the user's perspective. This means the user can't see the project or any associated issues.

keystring

The key of the project.

namestring

The name of the project.

projectTypeKey'software' | 'service_desk' | 'business' | 'product_discovery'

The project type of the project.

propertiesobject

Map of project properties. Only the properties named in the request's properties query parameter are returned, so this is an empty object when that parameter is omitted.

retentionTillDatestring date-time

The date when the project is deleted permanently.

rolesobject

The name and self URL for each role defined in the project. For more information, see Create project role.

selfstring uri

The URL of the project details.

simplifiedboolean

Whether the project is simplified.

style'classic' | 'next-gen'

The type of the project.

urlstring

A link to information about this project, such as project documentation.

uuidstring uuid

Unique ID for next-gen projects.

Changes

  • 38a98954789eRevision changes
    • warning

      added the new product_discovery enum value to the ///////////// response property for the response status

    • warning

      added the new product_discovery enum value to the / response property for the response status