Get projects paginated

GET

/rest/api/3/project/search

Projects

Returns a paginated list of projects visible to the user.

This operation can be accessed anonymously.

Permissions required: Projects are returned only where the user has one of:

Browse Projects project permission for the project.

Administer Projects project permission for the project.

Administer Jira global permission.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/project/search'

Response Example

200 - Success

{
  "self": "https://your-domain.atlassian.net/rest/api/3/project/search?startAt=0&maxResults=2",
  "nextPage": "https://your-domain.atlassian.net/rest/api/3/project/search?startAt=2&maxResults=2",
  "maxResults": 2,
  "startAt": 0,
  "total": 7,
  "isLast": false,
  "values": [
    {
      "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
      "id": "10000",
      "key": "EX",
      "name": "Example",
      "avatarUrls": {
        "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000",
        "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
        "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
        "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000"
      },
      "projectCategory": {
        "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000",
        "id": "10000",
        "name": "FIRST",
        "description": "First Project Category"
      },
      "simplified": false,
      "style": "classic",
      "insight": {
        "totalIssueCount": 100,
        "lastIssueUpdateTime": "2023-07-12T06:03:00.831+0000"
      }
    },
    {
      "self": "https://your-domain.atlassian.net/rest/api/3/project/ABC",
      "id": "10001",
      "key": "ABC",
      "name": "Alphabetical",
      "avatarUrls": {
        "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001",
        "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
        "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
        "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001"
      },
      "projectCategory": {
        "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000",
        "id": "10000",
        "name": "FIRST",
        "description": "First Project Category"
      },
      "simplified": false,
      "style": "classic",
      "insight": {
        "totalIssueCount": 100,
        "lastIssueUpdateTime": "2023-07-12T06:03:00.831+0000"
      }
    }
  ]
}

Request

Query Params

startAt

integer

optional

The index of the first item to return in a page of results (page offset).

maxResults

integer

optional

The maximum number of items to return per page.

orderBy

string

optional

Order the results by a field.

category Sorts by project category. A complete list of category IDs is found using Get all project categories.

issueCount Sorts by the total number of issues in each project.

key Sorts by project key.

lastIssueUpdatedTime Sorts by the last issue update time.

name Sorts by project name.

owner Sorts by project lead.

archivedDate EXPERIMENTAL. Sorts by project archived date.

deletedDate EXPERIMENTAL. Sorts by project deleted date.

array[string]

optional

The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Up to 50 project IDs can be provided.

keys

array[string]

optional

The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, keys=PA&keys=PB. Up to 50 project keys can be provided.

query

string

optional

Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive).

typeKey

string

optional

Orders results by the project type. This parameter accepts a comma-separated list. Valid values are business, service_desk, and software.

categoryId

integer

optional

The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.

action

string

optional

Filter results by projects for which the user can:

view the project, meaning that they have one of the following permissions:

Browse projects project permission for the project.

Administer projects project permission for the project.

Administer Jira global permission.

browse the project, meaning that they have the Browse projects project permission for the project.

edit the project, meaning that they have one of the following permissions:

Administer projects project permission for the project.

Administer Jira global permission.

expand

string

optional

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

description Returns the project description.

projectKeys Returns all project keys associated with a project.

lead Returns information about the project lead.

issueTypes Returns all issue types associated with the project.

url Returns the URL associated with the project.

insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.

status

array[string]

optional

EXPERIMENTAL. Filter results by project status:

live Search live projects.

archived Search archived projects.

deleted Search deleted projects, those in the recycle bin.

properties

array[string]

optional

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

propertyQuery

string

optional

EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of nested from {"something":{"nested":1,"other":2}} use [thepropertykey].something.nested=1. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters. Note that thepropertykey is only returned when included in properties.

Responses

🟢200Returned if the request is successful.

application/json

Body

A page of items.

isLast

boolean

read-onlyoptional

Whether this is the last page.

maxResults

integer <int32>

read-onlyoptional

The maximum number of items that could be returned.

string <uri>

read-onlyoptional

If there is another page of results, the URL of the next page.

self

string <uri>

read-onlyoptional

The URL of the page.

startAt

integer <int64>

read-onlyoptional

The index of the first item returned.

total

integer <int64>

read-onlyoptional

The number of items returned.

values

array[object (Project) {34}]

read-onlyoptional

The list of items.

archived

boolean

read-onlyoptional

Whether the project is archived.

archivedBy

object

read-onlyoptional

The user who archived the project.

archivedDate

string <date-time>

read-onlyoptional

The date when the project was archived.

assigneeType

enum<string>

read-onlyoptional

The default assignee when creating issues for this project.

Allowed values:

PROJECT_LEADUNASSIGNED

avatarUrls

object

read-onlyoptional

The URLs of the project's avatars.

components

array[object (ProjectComponent) {13}]

read-onlyoptional

List of the components contained in the project.

deleted

boolean

read-onlyoptional

Whether the project is marked as deleted.

deletedBy

object

read-onlyoptional

The user who marked the project as deleted.

deletedDate

string <date-time>

read-onlyoptional

The date when the project was marked as deleted.

description

string

read-onlyoptional

A brief description of the project.

string

optional

An email address associated with the project.

expand

string

read-onlyoptional

Expand options that include additional project details in the response.

favourite

boolean

optional

Whether the project is selected as a favorite.

string

optional

The ID of the project.

insight

object

read-onlyoptional

Insights about the project.

isPrivate

boolean

read-onlyoptional

Whether the project is private.

issueTypeHierarchy

object

read-onlyoptional

The issue type hierarchy for the project.

issueTypes

array[object (IssueTypeDetails) {10}]

read-onlyoptional

List of the issue types available in the project.

key

string

read-onlyoptional

The key of the project.

landingPageInfo

object

read-onlyoptional

The project landing page info.

lead

object

read-onlyoptional

The username of the project lead.

name

string

read-onlyoptional

The name of the project.

permissions

object

read-onlyoptional

User permissions on the project

projectCategory

object

read-onlyoptional

The category the project belongs to.

projectTypeKey

enum<string>

read-onlyoptional

The project type of the project.

Allowed values:

softwareservice_deskbusiness

properties

object

read-onlyoptional

Map of project properties

retentionTillDate

string <date-time>

read-onlyoptional

The date when the project is deleted permanently.

roles

object

read-onlyoptional

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

self

string <uri>

read-onlyoptional

The URL of the project details.

simplified

boolean

read-onlyoptional

Whether the project is simplified.

style

enum<string>

read-onlyoptional

The type of the project.

Allowed values:

classicnext-gen

url

string

read-onlyoptional

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

uuid

string <uuid>

read-onlyoptional

Unique ID for next-gen projects.

versions

array[object (Version) {17}]

read-onlyoptional

The versions defined in the project. For more information, see Create version.

🟠400Returned if the request is not valid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠404Returned if no projects matching the search criteria are found.

Modified at 2023-07-13 03:27:27

Get recent projects

Get project