Qodex.ai

Get Projects Paginated

GET {{baseUrl}}/rest/api/3/project/search?startAt=0&maxResults=50&orderBy=key&query=<string>&typeKey=<string>&categoryId=<long>&searchBy=key, name&action=view&expand=<string>&status=live&status=live

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:

Request Params

KeyDatatypeRequiredDescription
startAtnumberThe index of the first item to return in a page of results (page offset).
maxResultsnumberThe maximum number of items to return per page.
orderBystringOrder 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. | | query | string | | Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive). | | typeKey | string | | Orders results by the project type. This parameter accepts a comma-separated list. Valid values are business, service_desk, and software. | | categoryId | string | | The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation. | | searchBy | string | | | | action | string | | Filter results by projects for which the user can:

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

  • 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 | | 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 | string | | EXPERIMENTAL. Filter results by project status:

  • live Search live projects.

  • archived Search archived projects.

  • deleted Search deleted projects, those in the recycle bin. | | status | string | | EXPERIMENTAL. Filter results by project status:

  • live Search live projects.

  • archived Search archived projects.

  • deleted Search deleted projects, those in the recycle bin. |

RESPONSES

status: OK

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