List segments

GET

/api/v2/segments/:projectKey/:environmentKey

GET

/api/v2/segments/:projectKey/:environmentKey

curl https://app.launchdarkly.com/api/v2/segments/projectKey/environmentKey \
     -H "Authorization: <apiKey>"

{
  "items": [
    {
      "name": "Example segment",
      "tags": [
        "testing"
      ],
      "creationDate": 1654104600000,
      "lastModifiedDate": 1654104600000,
      "key": "segment-key-123abc",
      "_links": {},
      "rules": [
        {
          "clauses": [
            {
              "attribute": "email",
              "op": "endsWith",
              "values": [
                ".edu"
              ],
              "negate": false,
              "_id": "12ab3c45de678910fab12345"
            }
          ],
          "_id": "1234a56b7c89d012345e678f"
        }
      ],
      "version": 1,
      "deleted": false,
      "generation": 1,
      "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": 1,
        "includedCount": 1,
        "excludedCount": 1,
        "lastModified": 1,
        "deleted": true
      },
      "_external": "amplitude",
      "_externalLink": "https://analytics.amplitude.com/org/1234/cohort/123abc",
      "_importInProgress": false
    }
  ],
  "_links": {},
  "totalCount": 1
}

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 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: |<div style="width:120px">Field</div> |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`.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

environmentKeystringRequiredformat: "string"

The environment key

Query parameters

limitlongOptional

The number of segments to return. Defaults to 20.

offsetlongOptional

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.

sortstringOptionalformat: "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.

filterstringOptionalformat: "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

itemslist of objects

An array of segments

_linksmap from strings to objects

The location and content type of related resources

totalCountintegerOptional

The total number of segments

Errors

401

Unauthorized Error

404

Not Found Error