---
title: "List Fields"
method: GET
path: "/fields"
tags: ["Fields"]
---

# List Fields

`GET /fields`

## Request

- Base URL: `https://api.crowdin.com/api/v2`
- URL: `https://api.crowdin.com/api/v2/fields`
- Auth: none declared
- TypeScript: <https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/docs/fields/get.ts> (a function with typed inputs; its response is checked against the schema)

**Required scopes:** `field` (Read only).

## Query parameters

- `search` string
- `entity` 'project' | 'user' | 'task' | 'file' | 'translation' | 'string' | 'term' | 'concept'
- `type` 'checkbox' | 'radiobuttons' | 'date' | 'datetime' | 'number' | 'labels' | 'select' | 'multiselect' | 'text' | 'textarea' | 'url'
- `limit` integer
- `offset` integer

## Response `200`

Fields list

- FieldCollectionResource: Base schema of resource container. Container is a wrapper object that contains payload in required `data` property and provides space for adding any other metadata.
  - `data` FieldResource[], required
    - `data` Field, required: Class FieldResponseModel
      - `id` integer
      - `name` string
      - `slug` string
      - `description` string
      - `type` string
      - `config` object
      - `entities` string[]: Entities that will be associated with field
      - `createdAt` string, date-time: in UTC
      - `updatedAt` string, date-time: in UTC
  - `pagination` AdvancedPagination: Advanced Pagination Response Model
    - `offset` integer
    - `limit` integer
    - `total` integer

## Other responses

- `400`: Invalid Request Parameters
- `404`: Field with specified id was not found
- `405`: Method Not Allowed
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2.md) - [All operations](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/revisions/dc68744c5384?raw)