List Flags

get

https://api.optimizely.com/flags/v1/projects/{project_id}/flags

Get a list of Flags within a Project

You can use query parameters to filter/sort the response.

Path Params

project_id

integer

required

The project identifier

Query Params

per_page

int64

The max number of items to include per page or results.

page_number

int64

Bypass page_token to jump to specific page

page_token

string

Pagination page token. Implements prev, next, last, first

page_window

integer

Number of previous and next page links to supply for the request (defaults to 1).

sort

array of strings

Sort the Flags based on the attributes from left to right.

sort

archived

boolean

Filter the Flags by archived. A Flag can be either archived (archived=true) or unarchived (archived=false)

enabled

boolean

Filter the Flags by enabled. A Flag can be either enabled (enabled=true) or disabled (enabled=false)

rule_status

array of strings

Filter the Flags by Rule Status. Supports matching one, multiple, or excluding multiple values.

For matching one: rule_status=value
For matching multiple: rule_status=value1,value2
For excluding multiple: rule_status=!value1,!value2

rule_status

environment_status

array of strings

Filter the Flags by Environment Status. Supports matching one, multiple, or excluding multiple values.

For matching one: environment_status=value
For matching multiple: environment_status=value1,value2
For excluding multiple: environment_status=!value1,!value2

environment_status

environment_type

array of strings

Filter the Flags by the environment_type

environment_type

environment

array of strings

Filter the Flags by the environment

environment

rule_type

array of strings

Filter the Flags by the rule type.

rule_type

query

string

Filter the Flags by name, key, or description substring

key_list

array of strings

Filter the Flags by multiple keys

key_list

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400Malformed requests and invalid parameter names and types

401Invalid credentials

403Do not have permission to perform the operation