---
title: "List Entity Fields"
method: POST
path: "/metadata.describe/{TypeCode}"
tags: ["Metadata"]
---

# List Entity Fields

`POST /metadata.describe/{TypeCode}`

Retrieves information (data type, maximum length, possible values, whether the field is required, etc.) about fields of the specified entity.

## Query parameters

- `name` string
- `lookupTableId` string

## Response `200`

OK

- object
  - `response` object
    - `node` string
    - `data` object[]
      - `name` string — The name of the entity.
      - `typeCode` string — The type code of the entity.
      - `massEditable` boolean — When set to **true**, the multiple records at once can be edited in this entity.
      - `bulkLoadable` boolean — When set to **true**, a bulk data can be loaded to the entity using, for example, a **/loaddata/{TypeCode}** endpoint.
      - `businessKey` object[] — Fields that make up a business key.
      - `fields` object — Entity fields and corresponding properties.
    - `status` number

---

[API](https://skmtc.net/pricefx/apis/the-pricefx-backend-api.md) · [All operations](https://skmtc.net/pricefx/apis/the-pricefx-backend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pricefx/the-pricefx-backend-api/versions/0850b5d6be73/schema)