Skip to main content

List 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:

External Documentation

To learn more, visit the Jira documentation.

Basic Parameters​

ParameterDescription
LimitThe maximum number of items to return per page.
OffsetThe index of the first item to return in a page of results (page offset).

Advanced Parameters​

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

Example Output​

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

Workflow Library Example​

List Projects with Jira and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop