Get a list of all projects.

GET 
<your-unleash-url>/api/admin/projects

This endpoint returns an list of all the projects in the Unleash instance.

Request

Query Parameters

archived boolean

Responses

200

projectsSchema

application/json

Schema

Schema

versionintegerrequired
The schema version used to represent the project data.
Example: 1
projects object[]required
A list of projects in the Unleash instance
Array [
idstringrequired
The id of this project
Example: dx-squad
namestringrequired
The name of this project
Example: DX-Squad
descriptionstringnullabledeprecated
Additional information about the project
Example: DX squad feature release
healthnumber
An indicator of the project's health on a scale from 0 to 100
Example: 50
featureCountnumber
The number of features this project has
Example: 10
staleFeatureCountnumberdeprecated
The number of stale features this project has
Example: 10
potentiallyStaleFeatureCountnumberdeprecated
The number of potentially stale features this project has
Example: 10
memberCountnumber
The number of members this project has
Example: 4
createdAtdate-time
When this project was created.
Example: 2023-07-27T12:12:28Z
updatedAtdate-timenullabledeprecated
When this project was last updated.
Example: 2023-07-28T12:12:28Z
lastUpdatedAtdate-timenullable
When this project was last updated.
Example: 2023-07-28T12:12:28Z
archivedAtdate-timenullable
When this project was archived.
Example: 2023-07-28T12:12:28Z
favoriteboolean
true if the project was favorited, otherwise false.
Example: true
modestring
The project's collaboration mode. Determines whether non-project members can submit change requests or not.
Possible values: [open, protected, private]
Example: open
defaultStickinessstringdeprecated
A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy
Example: userId
avgTimeToProductionnumberdeprecated
The average time from when a feature was created to when it was enabled in the "production" environment during the current window
Example: 10
lastReportedFlagUsagedate-timenullable
Across all flags in your project this is the last time usage metrics where reported from connected applications.
Example: 2023-07-28T12:12:28Z
owners object
The users and/or groups that have the "owner" role in this project. If no such users or groups exist, the list will contain the "system" owner instead.
oneOf
MOD1
Array [
anyOf
MOD1
ownerTypestringrequired
Possible values: [user]
namestringrequired
Example: User Name
imageUrlstringnullable
Example: https://example.com/image.jpg
emailstringnullable
Example: user@example.com
MOD2
ownerTypestringrequired
Possible values: [group]
namestringrequired
Example: Group Name
]
MOD2
Array [
ownerTypestringrequired
Possible values: [system]
]
]

Example (auto)

{
  "version": 1,
  "projects": [
    {
      "id": "dx-squad",
      "name": "DX-Squad",
      "health": 50,
      "featureCount": 10,
      "memberCount": 4,
      "createdAt": "2023-07-27T12:12:28Z",
      "lastUpdatedAt": "2023-07-28T12:12:28Z",
      "archivedAt": "2023-07-28T12:12:28Z",
      "favorite": true,
      "mode": "open",
      "lastReportedFlagUsage": "2023-07-28T12:12:28Z",
      "owners": [
        {
          "ownerType": "user",
          "name": "User Name",
          "imageUrl": "https://example.com/image.jpg",
          "email": "user@example.com"
        },
        {
          "ownerType": "group",
          "name": "Group Name"
        }
      ]
    }
  ]
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/admin/projects' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

archived — query

---truefalse

ResponseClear

Click the Send API Request button above and see the response here!