---
title: "List field assignments for an entity kind"
method: GET
path: "/api/rest/v1/kind-field-assignments"
tags: ["Kind Field Assignments"]
---

# List field assignments for an entity kind

`GET /api/rest/v1/kind-field-assignments`

## Request

- Base URL: `https://app.componecat.ai`
- URL: `https://app.componecat.ai/api/rest/v1/kind-field-assignments`
- Auth: none required

Returns the kind's assigned field definitions in display order.

## Query parameters

- `kindId` string, uuid

## Response `200`

OK

- RestApiListResponseOfKindFieldAssignmentItem: Standard REST API response envelope for a collection of resources.
  - `data` KindFieldAssignmentItem[], required
    - `kindId` string, uuid, required: ID of the entity kind definition.
    - `fieldId` string, uuid, required: ID of the assigned field definition (see `/entity-field-definitions`).
    - `fieldKey` string, required: Key of the assigned field definition — the key its values use in an entity's `fieldValues`.
    - `required` boolean, required: Whether entities of the kind must supply a value for the field when created.
    - `displayOrder` union, required: Position in the kind's field list; lower values come first.
      - integer
      - string, int32
    - `category` string, nullable, required: Grouping category for the field on this kind. Null when not set.
  - `pagination` PaginationInfo, required: Pagination metadata for REST API list responses.
    - `cursor` string, nullable, required
    - `hasMore` boolean, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests

---

[API](https://skmtc.dev/componecat/apis/componecat-rest-api.md) · [All operations](https://skmtc.dev/componecat/apis/componecat-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/componecat/apis/componecat-rest-api/revisions/6c53d4984720?raw)