Get all features in a project

GET 
<your-unleash-url>/api/admin/projects/:projectId/features

A list of all features for the specified project.

Request

Path Parameters

projectId stringrequired

Responses

200

projectFeaturesSchema

application/json

Schema

Schema

versionintegerrequired
The version of the feature's schema
features object[]required
A list of features
Array [
namestringrequired
Unique feature name
Example: disable-comments
typestringrequired
Type of the flag e.g. experiment, kill-switch, release, operational, permission
Example: kill-switch
descriptionstringnullablerequired
Detailed description of the feature
Example: Controls disabling of the comments section in case of an incident
stalebooleanrequired
true if the feature is stale based on the age and feature type, otherwise false.
Example: false
favoritebooleanrequired
true if the feature was favorited, otherwise false.
Example: true
impressionDatabooleanrequired
true if the impression data collection is enabled for the feature, otherwise false.
Example: false
createdAtdate-timerequired
The date the feature was created
Example: 2023-01-28T15:21:39.975Z
lastSeenAtdate-timenullablerequireddeprecated
The date and time when metrics where last collected for this flag in any environment. This field was deprecated in v5. You should instead use the lastSeenAt property on the individual environments listed under the environments property.
Example: 2023-01-28T16:21:39.975Z
environments object[]required
The list of environments where the feature can be used
Array [
namestringrequired
The name of the environment
Example: my-dev-env
typestringrequired
The type of the environment
Example: development
enabledbooleanrequired
true if the feature is enabled for the environment, otherwise false.
Example: true
sortOrdernumberrequired
The sort order of the feature environment in the feature environments list
Example: 3
variantCountnumberrequired
The number of defined variants
lastSeenAtdate-timenullablerequired
The date when metrics where last collected for the feature environment
Example: 2023-01-28T16:21:39.975Z
hasStrategiesboolean
Whether the feature has any strategies defined.
hasEnabledStrategiesboolean
Whether the feature has any enabled strategies defined.
]
tags object[]nullable
The list of feature tags
Array [
valuestringrequired
The value of the tag.
Possible values: >= 2 characters and <= 50 characters
Example: a-tag-value
typestringrequired
The type of the tag
Possible values: >= 2 characters and <= 50 characters
Example: simple
]
]

Example (auto)

{
  "version": 0,
  "features": [
    {
      "name": "disable-comments",
      "type": "kill-switch",
      "description": "Controls disabling of the comments section in case of an incident",
      "stale": false,
      "favorite": true,
      "impressionData": false,
      "createdAt": "2023-01-28T15:21:39.975Z",
      "environments": [
        {
          "name": "my-dev-env",
          "type": "development",
          "enabled": true,
          "sortOrder": 3,
          "variantCount": 0,
          "lastSeenAt": "2023-01-28T16:21:39.975Z",
          "hasStrategies": true,
          "hasEnabledStrategies": true
        }
      ],
      "tags": [
        {
          "value": "a-tag-value",
          "type": "simple"
        }
      ]
    }
  ]
}

400

The request data does not match what we expect.

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: ValidationError
messagestring
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

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/:projectId/features' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

projectId — pathrequired

ResponseClear

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