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

# List fields

`GET /v1/fields`

Get a list of fields for a project or workspace field group.

You must provide either `project_id` or `workspace_field_group_id` in the filter, along with `field_set_type` (`data` or `doc`).

## Query parameters

- `page` object
  - `start_cursor` string
  - `limit` integer, nullable
- `sort` union
  - 'rank:asc' | 'rank:desc' | 'created_at:asc' | 'created_at:desc'
  - string[]
- `filter` object, required
  - `project_id` string — Unique identifier of the project.
  - `workspace_field_group_id` string — Unique identifier of the workspace field group.
  - `field_set_type` 'data' | 'doc', required — Filter by field set type: 'data' or 'doc'.

## Response `200`

200

- object
  - `data` object[], required
    - `id` string, required
    - `type` 'field', required
    - `label` string, required
    - `field_type` 'ARR' | 'BOOLEAN' | 'CSAT' | 'DATETIME' | 'EMAIL' | 'MULTI_SELECT' | 'NPS' | 'NUMBER' | 'PERSON' | 'PHONE' | 'RATING' | 'SINGLE_SELECT' | 'TEXT' | 'URL', required
    - `field_set_type` 'data' | 'doc', required
    - `project_id` string, required
    - `rank` number, required
    - `options` union, required
      - string[]
      - object
        - `format` string, nullable
        - `currency_symbol` string, nullable
    - `created_at` string, required
    - `deleted` boolean, required
  - `page` object, required
    - `total_count` number, required — Total number of items matching the query.
    - `has_more` boolean, required — Whether there are more items beyond the current page.
    - `next_cursor` string, nullable, required — Cursor to pass as `page[start_cursor]` to fetch the next page. Null when there are no more results.

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403
- `404` — 404
- `422` — 422
- `429` — 429
- `500` — 500

---

[API](https://skmtc.net/dovetail/apis/dovetail-public-api.md) · [All operations](https://skmtc.net/dovetail/apis/dovetail-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dovetail/dovetail-public-api/revisions/4107f5fdf8b2/schema)