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

# Listar campos

`GET /fields`

Lista os campos com base nos parâmetros fornecidos.

## Query parameters

- `page` number
- `size` number
- `search` string

## Response `200`

Successful response

- object — Página de registros
  - `data` object[], required — Lista de registros da página
    - `id` string, required — Identificador único do campo
    - `name` string, required — Nome do campo
    - `description` string, required — Descrição do campo
    - `active` boolean — Indica se o campo está ativo
    - `fixed` boolean
    - `type` 'text' | 'email' | 'phone' | 'number' | 'url' | 'boolean' | 'date' | 'choice' | 'multi_choice' | 'cpf' | 'cnpj' — Tipo do campo
    - `options` string[] — Lista de opções para campos do tipo `choice` ou `multi_choice`
    - `new` boolean — Flag de compatibilidade (integrações)
    - `workspaceId` string, required — Identificador do workspace associado
    - `createdBy` string, nullable, required — ID do usuário que criou o registro
    - `updatedBy` string, nullable, required — ID do usuário que atualizou o registro
    - `createdAt` string, date-time — Data de criação
    - `updatedAt` string, date-time — Data da última atualização
  - `meta` object, required — Metadados da página
    - `total` number, required — Total de registros
    - `page` number, required — Número da página atual
    - `size` number, required — Quantidade de registros da página
    - `first` number, required — Primeira página
    - `last` number, required — Última página
    - `next` number, nullable, required — Próxima página
    - `previous` number, nullable, required — Página anterior

## Other responses

- `default` — Error response

---

[API](https://skmtc.net/rdstationmentoria/apis/agents.md) · [All operations](https://skmtc.net/rdstationmentoria/apis/agents/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rdstationmentoria/agents/revisions/66aaaea086cc/schema)