---
title: "Listar campos personalizados"
method: GET
path: "/custom_fields"
tags: ["crm-v2-custom-fields"]
---

# Listar campos personalizados

`GET /custom_fields`

Listar campos personalizados da conta, permitindo filtrar por entidade (negociação, contato, etc.) para entender a estrutura de dados de cada recurso.

## Filtro

Propriedades disponíveis para filtro usando [RDQL](crm-v2-rdql-filtering).

| Propriedade | Tipo | Descrição |
| :--- | :--- | :--- |
| `entity` | `String` | Permite filtrar campos personalizados de uma entidade. Opções: `organization`, `deal`, `contact`, `product`. |
| `slug` | `String` | Permite filtrar campos personalizados pelo `slug`. |
| `is:required` | `Boolean` | Filtra por campos personalizados que são obrigatórios. |
| `is:visible` | `Boolean` | Filtra por campos personalizados que são visíveis. |

## Ordenação

Propriedades disponíveis para [ordenação](crm-v2-introduction#ordenação).

* `slug`
* `order`

## Query parameters

- `filter` string
- `sort` object
- `page` object
  - `number` integer — Número da página.
  - `size` integer — Tamanho da página.

## Response `200`

OK

- object
  - `data` object[] — Lista de recursos relacionados.
    - `id` string, hash
    - `info` string — Informações do campo personalizado.
    - `key` string — Variável a ser referenciada nos templates de mensagens.
    - `label` string — Rótulo do campo personalizado.
  - `links` object — Links de navegação da paginação.
    - `first` string, uri — Link para a primeira página.
    - `prev` string, uri — Link para a página anterior.
    - `self` string, uri — Link para a página atual.
    - `next` string, uri — Link para a próxima página.
    - `last` string, uri — Link para a última página.

## Other responses

- `400` — A requisição está malformada e não consegue ser processada.
- `401` — O token da API está ausente ou inválido.
- `403` — O token não tem permissão para acessar o recurso solicitado.
- `429` — O limite de requisições foi excedido.
- `500` — Internal Server Error

---

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