List Exclusion Groups

1 min

GET

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

Get a list of exclusion groups within a project

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

Path Parameters

project_idintegerrequired
Example
12345
Description
The project identifier

Query Parameters

per_pageinteger<int64>
Description
The max number of items to include per page or results.
Format
int64
page_tokenstring
Description
Pagination page token. Implements prev, next, last, first
page_windowinteger
Description
Number of previous and next page links to supply for the request (defaults to 1).
sortstring[]
Description
Sort the Groups based on the attributes from left to right.
archivedboolean
Description
Filter the Groups by archived. A Group can be either archived (archived=true) or unarchived (archived=false)
enabledboolean
Description
Filter the Groups by enabled. A Group can be either enabled (enabled=true) or disabled (enabled=false)
environmentstring[]
Description
Filter the Groups by the environment
querystring
Description
Filter the Groups by name or description substring
includestring[]
Description
Ensure that the group id listed is returned first

Responses

200

Successful retrieval of a page of Groups.

The response includes RESTful JSON (https://restfuljson.org/) styled links and pagination metadata. Objects in this API MAY include a url property for a link to itself and MAY append _url to properties for related links. If a link is not present in the response, it indicates a user is not authorized to access the related resource.

Groups
- countintegerrequired
  Example
  2
  Description
  Number of Groups on the current page.
- create_urlobject
  - UrlValue
- filter_urlobject
  Description
  Url template like '.../{?filter}'
  - UrlValue
- first_urlobjectrequired
  Description
  Link to first page of Groups in a series.
  - UrlValue
- itemsGroup[]required
  - archive_urlobject
    - UrlValue
  - archivedboolean
  - created_timestring<date-time>required
    Example
    2019-05-08T00:00:00.000Z
    Format
    date-time
  - delete_urlobject
    - UrlValue
  - descriptionstring
    Example
    promotion group
  - environment_keystringrequired
    Example
    production
    Min Length
    1
  - idintegerrequired
    Example
    1
  - namestringrequired
    Example
    PromoGroup
  - project_idinteger<int64>
    Description
    The ID of the Project this Group belongs to
    Format
    int64
  - revisioninteger
    Description
    Revision number for tracking changes
  - rolestring
    Example
    admin
    Description
    Granular permission role
  - rulesobject
    - GroupRuleMap
  - unarchive_urlobject
    - UrlValue
  - update_urlobject
    - UrlValue
  - updated_timestring<date-time>required
    Example
    2019-05-08T00:00:00.000Z
    Format
    date-time
  - urlobject
    Description
    Link to self
    - UrlValue
  - urnstringrequired
    Example
    groups.flag.optimizely.com::1
    Description
    The URN for the Group
- last_urlobjectrequired
  Description
  Link to the last page of Groups in a series.
  - UrlValue
- next_urlobject
  Description
  List of links to next pages of Groups in a series.
  
  The first element in the array is the exact next page after the current record, etc.
  - UrlList
- pageintegerrequired
  Example
  5
  Description
  Number of the current page. 1-index based.
- prev_urlobject
  Description
  List of links to previous pages of Groups in a series.
  
  The first element in the array is the exact previous page before the current record, etc.
  - UrlList
- reset_urlobject
  Description
  Link to the default pages of Groups
  - UrlValue
- sort_urlobject
  Description
  Url template like '.../{?sort}'
  - UrlValue
- total_countintegerrequired
  Example
  20
  Description
  Total number of Groups for this series.
- total_pagesintegerrequired
  Example
  10
  Description
  Total number of pages for this series.
- urlobjectrequired
  Description
  Link to self
  - UrlValue

400Malformed requests and invalid parameter names and types

401Invalid credentials

403Do not have permission to perform the operation

curl

curl --request GET \
     --url https://api.optimizely.com/flags/v1//projects/{project_id}/groups \
     --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/flags/v1//projects/{project_id}/groups", 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/flags/v1//projects/{project_id}/groups")

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/flags/v1//projects/{project_id}/groups"

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

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

print(response.text)

200

// Successful retrieval of a page of Groups.
The response includes RESTful JSON (https://restfuljson.org/) styled links and pagination metadata.
Objects in this API MAY include a url property for a link to itself and MAY append _url to properties for related links.
If a link is not present in the response, it indicates a user is not authorized to access the related resource.
{
  "count": 2,
  "create_url": {},
  "filter_url": {},
  "first_url": {},
  "items": [
    {
      "archive_url": {},
      "archived": false,
      "created_time": "2019-05-08T00:00:00.000Z",
      "delete_url": {},
      "description": "promotion group",
      "environment_key": "production",
      "id": 1,
      "name": "PromoGroup",
      "project_id": "",
      "revision": 0,
      "role": "admin",
      "rules": {},
      "unarchive_url": {},
      "update_url": {},
      "updated_time": "2019-05-08T00:00:00.000Z",
      "url": {},
      "urn": "groups.flag.optimizely.com::1"
    }
  ],
  "last_url": {},
  "next_url": {},
  "page": 5,
  "prev_url": {},
  "reset_url": {},
  "sort_url": {},
  "total_count": 20,
  "total_pages": 10,
  "url": {}
}

400

// Malformed requests and invalid parameter names and types

401

// Invalid credentials

403

// Do not have permission to perform the operation