---
title: "Get Entity Type Field"
method: GET
path: "/v2/entity-type-fields/{id}"
tags: ["Entity Type API"]
---

# Get Entity Type Field

`GET /v2/entity-type-fields/{id}`

Get an entity type field by ID, including its enum options.

## Path parameters

- `id` string, required — The ID of the entity type field.

## Response `200`

Success

- SvstorePublicapiGetEntityTypeFieldResponse
  - `data` SvstoreEntityTypeField
    - `id` string
    - `entityTypeId` string
    - `key` string
    - `name` string
    - `dataType` 'DATA_TYPE_UNSPECIFIED' | 'TEXT' | 'NUMBER' | 'BOOL' | 'TIMESTAMP' | 'ENUM' | 'ENTITY_REF' | 'USER_REF' | 'UNIQUE' | 'MULTI_SELECT' | 'FILE'
    - `createdAt` string, date-time — A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").
    - `updatedAt` string, date-time — A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").
    - `createdByUserId` string
    - `updatedByUserId` string
    - `enumOptions` SvstoreEnumOption[]
      - `id` string
      - `value` string
      - `displayName` string
      - `displayOrder` integer
    - `isKeyField` boolean — Whether this field's value drives the entity's key (dedup identifier). Must be a UNIQUE data type field. At most one per entity type.
    - `isNameField` boolean — Whether this field's value drives the entity's display name.
    - `refEntityTypeId` string, nullable — For ENTITY_REF fields: the entity type ID that this field references.
    - `description` string, nullable
    - `sourceEntityTypeId` string, nullable — If set, this field is inherited from the specified entity type. Empty means the field is defined directly on this entity type.
    - `sectionId` string, nullable — Visual grouping for the entity detail UI. Unset means the field renders in the implicit "Overview" tab.

## Other responses

- `default` — Error

---

[API](https://skmtc.net/serval/apis/serval-public-api.md) · [All operations](https://skmtc.net/serval/apis/serval-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/serval/serval-public-api/versions/0549515e9384/schema)