Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Projects

Get project

Returns the project details for a project.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project.

get/rest/api/3/project/{projectIdOrKey}

Path parameters

projectIdOrKeystring required

The project ID or project key (case sensitive).

Query parameters

expandstring

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include:

  • description The project description.
  • issueTypes The issue types associated with the project.
  • lead The project lead.
  • projectKeys All project keys associated with the project.
  • issueTypeHierarchy The project issue type hierarchy.
propertiesstring[]

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

Response

Returned if 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'

The project type of the project.

propertiesobject

Map of project properties

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.