---
title: "Get GTM entity fields"
method: GET
path: "/platform/v1/metadata/entities/{entityName}/fields"
tags: ["entities"]
---

# Get GTM entity fields

`GET /platform/v1/metadata/entities/{entityName}/fields`

## Request

- Base URL: `https://api.zoominfo.com/gtm`
- URL: `https://api.zoominfo.com/gtm/platform/v1/metadata/entities/{entityName}/fields`
- Auth: OAuth 2
  - Authorization code: `https://login.zoominfo.com`
  - Token URL: `https://okta-login.zoominfo.com/oauth2/default/v1/token` scopes: `api:gtm-data-model:read`

Retrieve detailed metadata and field definitions for a specific GTM entity

## Path parameters

- `entityName` 'account' | 'contact' | 'user', required

## Response `200`

Success

- GtmEntityFieldsResponse: Response model containing a collection of GTM entity field definitions.
  - `data` GtmEntityField[], required: The primary data of the document
    - `id` string, required: The unique identifier for the resource
    - `type` string, required: The type of the resource
    - `attributes` GtmEntityFieldAttributes, required: Attributes that define the characteristics and metadata of a field within a GTM entity.
      - `name` string, required: The unique identifier name of the field
      - `displayName` string, required: The human-readable name of the field
      - `dataType` string, required: The data type of the field
      - `required` boolean, required: Indicates whether this field is required
      - `fieldType` string, required: The classification type of the field
      - `description` string, required: A description explaining the purpose of this field
      - `pickListValues` string[]: Available predefined values for fields with limited options
      - `reference` string: Reference to another entity or field

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests

---

[API](https://skmtc.dev/zoominfo/apis/platform-api-v1.md) - [All operations](https://skmtc.dev/zoominfo/apis/platform-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/zoominfo/apis/platform-api-v1/revisions/3f7645433626?raw)