---
title: "Get a list of feature controls"
method: GET
path: "/api/feature-controls"
---

# Get a list of feature controls

`GET /api/feature-controls`

Returns a paginated list of feature controls with optional filtering by name, scope, or type.

## Query parameters

- `page` integer
- `pageSize` integer
- `name` string
- `displayName` string
- `owner` string
- `scope` string
- `type` 'list-string' | 'list-number' | 'boolean' | 'date' | 'string' | 'number'
- `status` 'active' | 'expired' | 'withdrawn'

## Headers

- `x-cdp-request-id` string

## Response `200`

Successfully retrieved the list of feature controls.

- FeatureControlsResponse
  - `items` DetailedFeatureControl[]
    - `name` string
    - `type` 'list-string' | 'list-number' | 'boolean' | 'date' | 'string' | 'number'
    - `value` union
      - string
      - number
      - boolean
      - string[]
      - number[]
    - `scopes` string[]
    - `status` 'active' | 'expired' | 'withdrawn'
    - `displayName` string
    - `description` string
    - `owner` string
    - `createdBy` string
    - `expiryDate` string, date-time
    - `roleRequired` string[]
    - `created` string, date-time
    - `lastUpdated` string, date-time
    - `lastUpdatedBy` string
    - `history` FeatureControlHistory[]
      - `value` union
        - string
        - number
        - boolean
        - string[]
        - number[]
      - `setBy` string
      - `dateTime` string, date-time
      - `note` string
  - `total` integer
  - `page` integer
  - `pageSize` integer
  - `totalPages` integer
  - `uniqueScopes` string[]

## Other responses

- `400` — Bad Request - Validation error.
- `401` — Unauthorized.

---

[API](https://skmtc.net/defra/apis/grants-config-broker-api.md) · [All operations](https://skmtc.net/defra/apis/grants-config-broker-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/defra/grants-config-broker-api/versions/8af3c6dc00fe/schema)
