---
title: "List all custom fields"
method: GET
path: "/v1/custom-fields"
tags: ["v1CustomFields"]
---

# List all custom fields

`GET /v1/custom-fields`

## Response `200`

- CustomFieldCursorPaginatedResponseDto
  - `data` CustomFieldPublicDto[], required
    - `id` string, required
    - `name` string, required — Nome do campo
    - `description` string — Descrição para te ajudar a saber para que serve esse campo
    - `entity` 'contact' | 'group' | 'channel' | 'session' | 'user' | 'product' | 'task' | 'deal' — Descrição para te ajudar a saber para que serve esse campo
    - `placeholder` string — Chave que identifica esse campo em vários lugares. Geralmente é o nome em lowercase
    - `type` 'text' | 'textarea' | 'number' | 'decimal' | 'select' | 'multi-select' | 'boolean' | 'date' | 'day' | 'datetime' | 'json', required — O tipo de campo que será mostrado e parseado
    - `options` CustomFieldOption[] — Em caso de ser o tipo select ou multi-select é necessário ter as opções específicas que podem ser selecionadas
      - `value` string, required — Valor da opção
      - `label` string, required — Título que o valor representa
    - `isActive` boolean, required
    - `isDeleted` boolean, required
    - `invisible` boolean, required — Se ativo não mostra no plugin de contato em uma conversa
    - `position` number, required
    - `isUniqueIdentifier` boolean, required
    - `isIntegration` boolean, required — Se é um campo usado para uma integração
    - `showAlways` boolean, required
    - `requiredToResolve` boolean, required — Caso ativo somente permite resolver conversa se esse campo estiver ativado
    - `resetOnNewCall` boolean, required — Caso ativo quando for uma nova sessão esse campo será resetado.

---

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