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

# Get Filterable Fields

> Returns the available fields that can be used to filter leads, grouped
by core fields, date fields, and custom fields.
Requires `leads:view` permission.




## OpenAPI

````yaml GET /api/leads/filterable-fields
openapi: 3.1.0
info:
  title: Naturalead Leads API
  version: 1.0.0
  description: |
    API for managing leads in the Naturalead platform. All endpoints require
    API key authentication and are scoped to the caller's account.
servers:
  - url: '{baseUrl}'
    description: API server
    variables:
      baseUrl:
        default: http://localhost:3001
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Leads
    description: Lead CRUD, search, filtering, and bulk operations
paths:
  /api/leads/filterable-fields:
    get:
      tags:
        - Leads
      summary: Get filterable fields
      description: |
        Returns the available fields that can be used to filter leads, grouped
        by core fields, date fields, and custom fields.
        Requires `leads:view` permission.
      operationId: getFilterableFields
      responses:
        '200':
          description: Available filterable fields
          content:
            application/json:
              schema:
                type: object
                properties:
                  coreFields:
                    type: array
                    items:
                      $ref: '#/components/schemas/FilterField'
                  dateFields:
                    type: array
                    items:
                      $ref: '#/components/schemas/FilterField'
                  customFields:
                    type: array
                    items:
                      $ref: '#/components/schemas/FilterField'
                required:
                  - coreFields
                  - dateFields
                  - customFields
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    FilterField:
      type: object
      properties:
        field:
          type: string
        label:
          type: string
        type:
          type: string
          enum:
            - text
            - enum
            - multi
            - date
        group:
          type: string
        options:
          type: array
          items:
            type: string
      required:
        - field
        - label
        - type
        - group
  responses:
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key prefixed with `nl_live_` or `nl_test_`
    BearerAuth:
      type: http
      scheme: bearer
      description: Bearer token using an API key (format nl_live_* or nl_test_*)

````