---
title: "List configurations"
method: GET
path: "/entities/configurations"
tags: ["entities"]
---

# List configurations

`GET /entities/configurations`

Returns metadata for all available Entities type, including supported fields, patch operations, and validation rules.  
Use this to programmatically discover what entity types are available for your workspace, which fields are required,
what types are available, and how your workspace is configured.

## Query parameters

- `type[]` EntityType[]

## Response `200`

A paginated list of configurations

- object
  - `data` Configuration[]
    - `type` 'product' | 'component' | 'feature' | 'subfeature' | 'initiative' | 'objective' | 'keyResult' | 'release' | 'releaseGroup' | 'company' | 'user' — Supported Entity types: - product - component - feature - subfeature - initiative - objective - keyResult - release - releaseGroup - company - user The exact types available may vary based on the configuration of the workspace.
    - `fields` object — A key-value definition fields that are part of the entity. Key represents field id (eg. name, description, or UUID)
    - `relationships` object — A key-value definition of possible relationships to other entities. Key represents the relationship type to other entities (child, parent, link)
    - `filters` ConfigurationFilterParameter[] — Available filter parameters for this entity type. Use these as query parameters on `GET /v2/entities` or as keys in `POST /v2/entities/search` request body. Not all entity types support the same filters — this list is type-specific.
      - `name` string, required — The query parameter name to use when filtering. Use this exact name as a query parameter on `GET /v2/entities` or as a key in the `POST /v2/entities/search` request body.
      - `field` string — The field ID this filter applies to, when the filter is based on a field.
      - `relationship` string — The relationship key this filter applies to, when the filter is based on a relationship.
      - `schema` ConfigurationFilterSchema, required — Describes the expected value type and format for a filter parameter.
        - `type` 'string' | 'boolean' | 'integer' | 'number', required — The value type expected for this filter.
        - `format` 'uuid' | 'email' | 'date' | 'date-time' — Additional format hint for the value.
      - `requiredScopes` string[] — OAuth2 scopes required to use this filter, beyond the standard entity scopes. Omitted when no additional scopes are needed.
    - `links` ResourceLinks
      - `self` string, required
  - `links` ListLinks
    - `next` string, nullable, required

## Other responses

- `400` — Bad Request - Invalid input format or malformed request
- `401` — Unauthorized - Missing or invalid authentication credentials
- `403` — Forbidden - Insufficient permissions
- `404` — Not Found - The requested resource does not exist or is not accessible
- `408` — Request Timeout - The server did not receive a complete request within the allowed time
- `429` — Too Many Requests - API rate limit exceeded, reduce request frequency and retry after the indicated time
- `500` — Internal Server Error - An unexpected error occurred on the server, please retry or contact support

---

[API](https://skmtc.dev/productboard/apis/notes.md) · [All operations](https://skmtc.dev/productboard/apis/notes/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/productboard/notes/revisions/b4004749b60f/schema)