> ## Documentation Index
> Fetch the complete documentation index at: https://developers.nuvia.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List custom fields

> Returns a paginated list of the company's custom fields. Use it to discover each field's `slug` — it's the `slug`, not the `_id`, that identifies the field when writing a value via `PUT /v1/contacts/{id}` or `PUT /v1/conversations/{id}`.



## OpenAPI

````yaml /en/openapi.json get /v1/custom-fields
openapi: 3.0.0
info:
  title: Nuvia API - Company
  description: API documentation for companies
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nuvia.ai
security: []
tags:
  - name: messages
    x-group: Mensagens
  - name: contacts
    x-group: Contatos
  - name: campaigns
    x-group: Campanhas
  - name: tables
    x-group: Tabelas e Listas
  - name: agents
    x-group: Agentes
  - name: conversations
    x-group: Conversas
  - name: inboxes
    x-group: Caixas de Entrada
  - name: knowledge
    x-group: Base de Conhecimento
  - name: Webhooks
    x-group: Webhooks
  - name: campaign-enrollments
    x-group: Inscrições em Campanha
  - name: custom-fields
    x-group: Campos Customizados
paths:
  /v1/custom-fields:
    get:
      tags:
        - custom-fields
      summary: List custom fields
      description: >-
        Returns a paginated list of the company's custom fields. Use it to
        discover each field's `slug` — it's the `slug`, not the `_id`, that
        identifies the field when writing a value via `PUT /v1/contacts/{id}` or
        `PUT /v1/conversations/{id}`.
      operationId: CustomFieldController_findCustomFields
      parameters:
        - name: context
          required: false
          in: query
          description: 'Field context: conversation, contact, or business'
          schema:
            type: string
        - name: type
          required: false
          in: query
          description: 'Filter by field type(s), comma-separated (e.g.: text,number)'
          schema:
            type: string
        - name: page
          required: false
          in: query
          description: Page number (starts at 1)
          schema:
            type: string
        - name: rowsPerPage
          required: false
          in: query
          description: Number of items per page
          schema:
            type: string
        - name: search
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: List of custom fields returned successfully
        '401':
          description: Invalid or expired token
        '403':
          description: You do not have permission to access this resource
      security:
        - JWT-auth: []
components:
  securitySchemes:
    JWT-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Token JWT de autenticação

````