List segments

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey} \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "items": [
    {
      "name": "Example segment",
      "tags": [
        "testing"
      ],
      "creationDate": "1654104600000",
      "lastModifiedDate": "1654104600000",
      "key": "segment-key-123abc",
      "_links": {},
      "rules": [
        {
          "_id": "1234a56b7c89d012345e678f",
          "clauses": [
            {
              "_id": "12ab3c45de678910fab12345",
              "attribute": "email",
              "negate": false,
              "op": "endsWith",
              "values": [
                ".edu"
              ]
            }
          ]
        }
      ],
      "version": 1,
      "deleted": false,
      "generation": 123,
      "description": "Bundle our sample customers together",
      "included": [
        "user-key-123abc"
      ],
      "excluded": [
        "user-key-123abc"
      ],
      "includedContexts": [
        {
          "values": [
            "<string>"
          ],
          "contextKind": "<string>"
        }
      ],
      "excludedContexts": [
        {
          "values": [
            "<string>"
          ],
          "contextKind": "<string>"
        }
      ],
      "_access": {
        "denied": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ],
        "allowed": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ]
      },
      "_flags": [
        {
          "name": "Example flag",
          "key": "flag-key-123abc",
          "_links": {},
          "_site": {
            "href": "<string>",
            "type": "<string>"
          }
        }
      ],
      "unbounded": false,
      "unboundedContextKind": "<string>",
      "_unboundedMetadata": {
        "envId": "<string>",
        "segmentId": "<string>",
        "version": 123,
        "includedCount": 123,
        "excludedCount": 123,
        "lastModified": 123,
        "deleted": true
      },
      "_external": "amplitude",
      "_externalLink": "https://analytics.amplitude.com/org/1234/cohort/123abc",
      "_importInProgress": false
    }
  ],
  "_links": {},
  "totalCount": 123
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

List segments

Get a list of all segments in the given project.

Segments can be rule-based, list-based, or synced. Big segments include larger list-based segments and synced segments. Some fields in the response only apply to big segments.

Filtering segments

The filter parameter supports the following operators: equals, anyOf, and exists.

You can also combine filters in the following ways:

Use a comma (,) as an AND operator
Use a vertical bar (|) as an OR operator
Use parentheses (()) to group filters

Supported fields and operators

You can only filter certain fields in segments when using the filter parameter. Additionally, you can only filter some fields with certain operators.

When you search for segments, the filter parameter supports the following fields and operators:

Field	Description	Supported operators
`excludedKeys`	The segment keys of segments to exclude from the results.	`anyOf`
`external`	Whether the segment is a synced segment.	`exists`
`includedKeys`	The segment keys of segments to include in the results.	`anyOf`
`query`	A “fuzzy” search across segment key, name, and description. Supply a string or list of strings to the operator.	`equals`
`tags`	The segment tags.	`anyOf`
`unbounded`	Whether the segment is a standard segment (`false`) or a big segment (`true`). Standard segments include rule-based segments and smaller list-based segments. Big segments include larger list-based segments and synced segments.	`equals`

Here are a few examples:

The filter ?filter=tags anyOf ["enterprise", "beta"],query equals "toggle" matches segments with “toggle” in their key, name, or description that also have “enterprise” or “beta” as a tag.
The filter ?filter=excludedKeys anyOf ["segmentKey1", "segmentKey2"] excludes the segments with those keys from the results.
The filter ?filter=unbounded equals true matches larger list-based segments and synced segments.

The documented values for filter query parameters are prior to URL encoding. For example, the [ in ?filter=tags anyOf ["enterprise", "beta"] must be encoded to %5B.

GET

api

segments

{projectKey}

{environmentKey}

List segments

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey} \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "items": [
    {
      "name": "Example segment",
      "tags": [
        "testing"
      ],
      "creationDate": "1654104600000",
      "lastModifiedDate": "1654104600000",
      "key": "segment-key-123abc",
      "_links": {},
      "rules": [
        {
          "_id": "1234a56b7c89d012345e678f",
          "clauses": [
            {
              "_id": "12ab3c45de678910fab12345",
              "attribute": "email",
              "negate": false,
              "op": "endsWith",
              "values": [
                ".edu"
              ]
            }
          ]
        }
      ],
      "version": 1,
      "deleted": false,
      "generation": 123,
      "description": "Bundle our sample customers together",
      "included": [
        "user-key-123abc"
      ],
      "excluded": [
        "user-key-123abc"
      ],
      "includedContexts": [
        {
          "values": [
            "<string>"
          ],
          "contextKind": "<string>"
        }
      ],
      "excludedContexts": [
        {
          "values": [
            "<string>"
          ],
          "contextKind": "<string>"
        }
      ],
      "_access": {
        "denied": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ],
        "allowed": [
          {
            "action": "<string>",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "<string>"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "<string>"
              ],
              "role_name": "<string>"
            }
          }
        ]
      },
      "_flags": [
        {
          "name": "Example flag",
          "key": "flag-key-123abc",
          "_links": {},
          "_site": {
            "href": "<string>",
            "type": "<string>"
          }
        }
      ],
      "unbounded": false,
      "unboundedContextKind": "<string>",
      "_unboundedMetadata": {
        "envId": "<string>",
        "segmentId": "<string>",
        "version": 123,
        "includedCount": 123,
        "excludedCount": 123,
        "lastModified": 123,
        "deleted": true
      },
      "_external": "amplitude",
      "_externalLink": "https://analytics.amplitude.com/org/1234/cohort/123abc",
      "_importInProgress": false
    }
  ],
  "_links": {},
  "totalCount": 123
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

Authorizations

Authorization

string

header

required

Path Parameters

projectKey

string<string>

required

The project key

environmentKey

string<string>

required

The environment key

Query Parameters

limit

integer<int64>

The number of segments to return. Defaults to 20.

offset

integer<int64>

Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

sort

string<string>

Accepts sorting order and fields. Fields can be comma separated. Possible fields are 'creationDate', 'name', 'lastModified'. Example: sort=name sort by names ascending or sort=-name,creationDate sort by names descending and creationDate ascending.

filter

string<string>

Accepts filter by excludedKeys, external, includedKeys, query, tags, unbounded, view. To learn more about the filter syntax, read the 'Filtering segments' section above.

Response

Segment collection response

items

object[]

required

An array of segments

Show child attributes

_links

object

required

The location and content type of related resources

Show child attributes

totalCount

integer

The total number of segments