Skip to main content
GET
/
v1
/
segments
List Segment
curl --request GET \
  --url https://flags.eu.confidence.dev/v1/segments \
  --header 'Authorization: Bearer <token>'
{
  "segments": [
    {
      "createTime": {},
      "updateTime": {},
      "creator": "<string>",
      "updater": "<string>",
      "name": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "targeting": {
        "criteria": [
          {}
        ],
        "expression": {
          "ref": "<string>",
          "not": {},
          "and": {
            "operands": [
              {}
            ]
          },
          "or": {
            "operands": [
              {}
            ]
          }
        }
      },
      "allocation": {
        "proportion": {
          "value": "<string>"
        },
        "exclusivityTags": [
          "<string>"
        ],
        "exclusiveTo": [
          "<string>"
        ]
      },
      "state": "STATE_UNSPECIFIED",
      "bitsetAllocation": {
        "bitset": {}
      },
      "labels": [
        {}
      ],
      "workflowInstance": "<string>",
      "flag": "<string>",
      "owner": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
pageSize
object

The maximum number of segments to fetch.

​
pageToken
string

Token used for pagination.

​
view
enum<string>

Specifies which fields of the segments that should be set.

Available options:
SEGMENT_VIEW_UNSPECIFIED,
BASIC,
FULL
​
filter
string

Filter to apply to the segments. This follows the lucene query string format

​
orderBy
string

Provide fields and direction to sort by. Will always tiebreak on name. Format: {"<"}field_0{">"}:{"<"}direction{">"}, {"<"}field_1{">"}:{"<"}direction{">"} Example: displayName:desc,createTime:asc

Response

200 - application/json

OK

​
segments
Segment · object[]
required

Segment: The list of segments.

​
nextPageToken
string

A token that can be used to fetch more segments, empty if no more rules are available.