---
title: "List a project's segments, newest first"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Feature Flags API

`GET /v1/organizations/{orgId}/projects/{projectId}/segments`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `ListSegments.path.orgId` (string, required)
  - format `uuid`
- `ListSegments.path.projectId` (string, required)
  - format `uuid`

## Query parameters

- `ListSegments.query.limit` (integer, optional) — The page size. Out of range is 400, never a clamp.
  - min 1; max 100; default `20`
- `ListSegments.query.cursor` (string, optional) — The previous page's nextCursor. Bound to the organization, the list and its filters.

## Code samples

### cURL

```curl
curl --request GET \
  --url https://flags-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/segments \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://flags-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/segments';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://flags-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/segments"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
```

## Responses

### 200

A page of segments.

#### Example

```json
{
  "nextCursor": "string",
  "segments": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "excluded": [
        "string"
      ],
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "included": [
        "string"
      ],
      "key": "string",
      "name": "string",
      "resourceName": "string",
      "rules": [
        {
          "clauses": [
            {
              "attribute": "string",
              "operator": "in",
              "values": [
                null
              ]
            }
          ],
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
      ],
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
```

- `ListSegments.response.200.nextCursor` (string | null, required)
- `ListSegments.response.200.segments` (array<object>, required)
  - `ListSegments.response.200.segments.createdAt` (string, required)
    - format `date-time`
  - `ListSegments.response.200.segments.description` (string, required)
    - maxLength 1000
  - `ListSegments.response.200.segments.excluded` (array<string>, required)
  - `ListSegments.response.200.segments.id` (string, required)
    - format `uuid`
  - `ListSegments.response.200.segments.included` (array<string>, required)
  - `ListSegments.response.200.segments.key` (string, required) — Lowercase letters, digits, _ and -, starting with a letter or digit; at most 64 characters. Immutable.
    - pattern `^[a-z0-9][a-z0-9_-]{0,63}$`
  - `ListSegments.response.200.segments.name` (string, required)
    - maxLength 100
  - `ListSegments.response.200.segments.resourceName` (string, required)
  - `ListSegments.response.200.segments.rules` (array<object>, required)
    - `ListSegments.response.200.segments.rules.clauses` (array<object>, required) — ANDed; at most 10. Rules are ORed.
      - `ListSegments.response.200.segments.rules.clauses.operator` (unknown, required)
        - one of `"in"`, `"notIn"`, `"contains"`, `"startsWith"`, `"endsWith"`, `"lt"`, `"lte"`, `"gt"`, `"gte"`, `"semverEq"`, `"semverLt"`, `"semverGt"`, `"segmentMatch"`, `"notSegmentMatch"`
      - `ListSegments.response.200.segments.rules.clauses.values` (array<string | number | boolean>, required) — Strings, numbers or booleans (booleans with in and notIn); segment keys for the segment operators. At most 1,000.
      - `ListSegments.response.200.segments.rules.clauses.attribute` (string, optional) — A context attribute; dot paths reach nested ones (company.plan). Absent for segmentMatch and notSegmentMatch.
    - `ListSegments.response.200.segments.rules.id` (string, required)
      - format `uuid`
  - `ListSegments.response.200.segments.updatedAt` (string, required)
    - format `date-time`

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListSegments.response.400.error` (object, required)
  - `ListSegments.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListSegments.response.400.error.message` (string, required)
    - maxLength 1024
  - `ListSegments.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListSegments.response.400.error.issues.message` (string, required)
    - `ListSegments.response.400.error.issues.path` (string, required)
  - `ListSegments.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListSegments.response.400.error.quota.id` (string, required)
    - `ListSegments.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListSegments.response.400.error.quota.limit` (integer, required)
      - min 0
    - `ListSegments.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListSegments.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListSegments.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListSegments.response.400.error.quota.region` (string, optional)
    - `ListSegments.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListSegments.response.400.error.quota.scopeResourceName` (string, optional)
    - `ListSegments.response.400.error.quota.used` (integer, optional)
      - min 0
    - `ListSegments.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListSegments.response.401.error` (object, required)
  - `ListSegments.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListSegments.response.401.error.message` (string, required)
    - maxLength 1024
  - `ListSegments.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListSegments.response.401.error.issues.message` (string, required)
    - `ListSegments.response.401.error.issues.path` (string, required)
  - `ListSegments.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListSegments.response.401.error.quota.id` (string, required)
    - `ListSegments.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListSegments.response.401.error.quota.limit` (integer, required)
      - min 0
    - `ListSegments.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListSegments.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListSegments.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListSegments.response.401.error.quota.region` (string, optional)
    - `ListSegments.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListSegments.response.401.error.quota.scopeResourceName` (string, optional)
    - `ListSegments.response.401.error.quota.used` (integer, optional)
      - min 0
    - `ListSegments.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListSegments.response.403.error` (object, required)
  - `ListSegments.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListSegments.response.403.error.message` (string, required)
    - maxLength 1024
  - `ListSegments.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListSegments.response.403.error.issues.message` (string, required)
    - `ListSegments.response.403.error.issues.path` (string, required)
  - `ListSegments.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListSegments.response.403.error.quota.id` (string, required)
    - `ListSegments.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListSegments.response.403.error.quota.limit` (integer, required)
      - min 0
    - `ListSegments.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListSegments.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListSegments.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListSegments.response.403.error.quota.region` (string, optional)
    - `ListSegments.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListSegments.response.403.error.quota.scopeResourceName` (string, optional)
    - `ListSegments.response.403.error.quota.used` (integer, optional)
      - min 0
    - `ListSegments.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListSegments.response.404.error` (object, required)
  - `ListSegments.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListSegments.response.404.error.message` (string, required)
    - maxLength 1024
  - `ListSegments.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListSegments.response.404.error.issues.message` (string, required)
    - `ListSegments.response.404.error.issues.path` (string, required)
  - `ListSegments.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListSegments.response.404.error.quota.id` (string, required)
    - `ListSegments.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListSegments.response.404.error.quota.limit` (integer, required)
      - min 0
    - `ListSegments.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListSegments.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListSegments.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListSegments.response.404.error.quota.region` (string, optional)
    - `ListSegments.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListSegments.response.404.error.quota.scopeResourceName` (string, optional)
    - `ListSegments.response.404.error.quota.used` (integer, optional)
      - min 0
    - `ListSegments.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListSegments.response.429.error` (object, required)
  - `ListSegments.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListSegments.response.429.error.message` (string, required)
    - maxLength 1024
  - `ListSegments.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListSegments.response.429.error.issues.message` (string, required)
    - `ListSegments.response.429.error.issues.path` (string, required)
  - `ListSegments.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListSegments.response.429.error.quota.id` (string, required)
    - `ListSegments.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListSegments.response.429.error.quota.limit` (integer, required)
      - min 0
    - `ListSegments.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListSegments.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListSegments.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListSegments.response.429.error.quota.region` (string, optional)
    - `ListSegments.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListSegments.response.429.error.quota.scopeResourceName` (string, optional)
    - `ListSegments.response.429.error.quota.used` (integer, optional)
      - min 0
    - `ListSegments.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListSegments.response.500.error` (object, required)
  - `ListSegments.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListSegments.response.500.error.message` (string, required)
    - maxLength 1024
  - `ListSegments.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListSegments.response.500.error.issues.message` (string, required)
    - `ListSegments.response.500.error.issues.path` (string, required)
  - `ListSegments.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListSegments.response.500.error.quota.id` (string, required)
    - `ListSegments.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListSegments.response.500.error.quota.limit` (integer, required)
      - min 0
    - `ListSegments.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListSegments.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListSegments.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListSegments.response.500.error.quota.region` (string, optional)
    - `ListSegments.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListSegments.response.500.error.quota.scopeResourceName` (string, optional)
    - `ListSegments.response.500.error.quota.used` (integer, optional)
      - min 0
    - `ListSegments.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListSegments.response.503.error` (object, required)
  - `ListSegments.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListSegments.response.503.error.message` (string, required)
    - maxLength 1024
  - `ListSegments.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListSegments.response.503.error.issues.message` (string, required)
    - `ListSegments.response.503.error.issues.path` (string, required)
  - `ListSegments.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListSegments.response.503.error.quota.id` (string, required)
    - `ListSegments.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListSegments.response.503.error.quota.limit` (integer, required)
      - min 0
    - `ListSegments.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListSegments.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListSegments.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListSegments.response.503.error.quota.region` (string, optional)
    - `ListSegments.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListSegments.response.503.error.quota.scopeResourceName` (string, optional)
    - `ListSegments.response.503.error.quota.used` (integer, optional)
      - min 0
    - `ListSegments.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/flags-api/ListSegments/index.md