Get Features by Project

1 min

GET

https://api.optimizely.com/v2/features

Get all of the Features that have been created in a given Project. Note this endpoint is incompatible with Full Stack Targeted Rollouts projects (default in accounts created after July 2020) and with non-legacy Full Stack projects (default in projects created after February 2021). See the compatible API at https://library.optimizely.com/docs/api/flags/v1/index.html#tag/Flags.

Query Parameters

per_pageinteger
Description
Optional pagination argument that specifies the maximum number of objects to return per request
Default
25
Maximum
100
pageinteger
Description
Optional pagination argument that specifies the page to return. If you have 140 objects and you choose to return 100 objects per page you will be able to access the last 40 objects on page 2. The default value is 1.
Default
1
project_idinteger<int64>required
Description
The ID of the project for which you would like to get Features
Format
int64

Responses

200Return all Features in a specified Project

Feature[]
- archivedboolean
  Description
  Whether the Feature has been archived
  Default
  false
- createdstring<date-time>
  Description
  Time when the Feature was created
  Format
  date-time
- descriptionstring
  Description
  A short description of this Feature
- environmentsmap<string, FeatureEnvironment>
  Description
  The configuration for this Feature's Rollout within each Environment, keyed by Environment key
- idinteger<int64>
  Description
  The ID of this Feature
  Format
  int64
- keystringrequired
  Example
  new_checkout_page
  Description
  Unique string identifier for this Feature within the Project
  Max Length
  64
  Pattern
  ^[a-zA-Z0-9_\-]+$
- last_modifiedstring<date-time>
  Description
  Date last modified
  Format
  date-time
- namestring
  Example
  the checkout feature
  Description
  Name of the Feature
- project_idinteger<int64>required
  Description
  The ID of the Project this Feature belongs to
  Format
  int64
- variablesFeatureVariable[]
  Description
  Variables define the dynamic configuration of a feature, and each variable can take on a different value on a per-variation basis within a feature test.
  - archivedboolean
    Description
    Whether or not this Feature Variable is archived
    Default
    false
  - default_valuestringrequired
    Example
    0.05
    Description
    The stringified default value for this Feature Variable. The default value is the value Optimizely SDKs will return when this Feature Variable is accessed by getFeatureVariableValue unless the Feature Variable's value is a part of a feature test variation.
  - idinteger<int64>
    Description
    The ID of this Feature Variable
    Format
    int64
  - keystringrequired
    Description
    Unique string identifier for this Feature Variable within the Feature
  - typestring<boolean | string | double | integer | json>required
    Example
    double
    Description
    The datatype for this Feature Variable
    Allowed
    booleanstringdoubleintegerjson

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have permission to access to the Features in the specified Project

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request GET \
     --url 'https://api.optimizely.com/v2/features?per_page=25&page=1&project_id=integer%3Cint64%3E' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/features?per_page=25&page=1&project_id=integer<int64>", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/features?per_page=25&page=1&project_id=integer<int64>")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/v2/features?per_page=25&page=1&project_id=integer<int64>"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Return all Features in a specified Project
[
  {
    "archived": false,
    "created": "",
    "description": "",
    "environments": "",
    "id": "",
    "key": "new_checkout_page",
    "last_modified": "",
    "name": "the checkout feature",
    "project_id": "",
    "variables": [
      {
        "archived": false,
        "default_value": "0.05",
        "id": "",
        "key": "",
        "type": "double"
      }
    ]
  }
]

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to access to the Features in the specified Project
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}