Skip to main content
GET
/
api
/
projects
List projects
curl --request GET \
  --url https://api.example.com/api/projects \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": "v1",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "key": "<string>",
      "protected": true,
      "deletedAt": "<string>",
      "decisionsApprovalMode": "require_one_per_team",
      "decisionsApprovalGroups": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "description": "<string>",
          "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "members": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "owner": true,
          "user": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "email": "[email protected]",
            "firstName": "<string>",
            "lastName": "<string>"
          }
        }
      ]
    }
  ],
  "paginate": {
    "current": 123,
    "from": 123,
    "to": 123,
    "total": 123,
    "pageSize": 123
  }
}

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Query Parameters

Search term to filter projects by name

all
default:false

If true, list all projects in the organisation (admin/owner only)

Available options:
true,
false,
True,
False,
TRUE,
FALSE
deleted
default:false

If true, list soft-deleted projects (admin/owner only)

Available options:
true,
false,
True,
False,
TRUE,
FALSE
page
number
default:1

Current page

perPage
number
default:10

Number of items per page

Response

200 - application/json

Paginated list of projects

Paginated list of projects

results
object[]
required

List of projects

paginate
object
required

Pagination metadata