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

# List custom_fields

> List all custom fields. book_id is accepted for backwards compatibility but ignored.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/custom_fields
openapi: 3.0.1
info:
  title: Slant Public API V1
  version: v1
  description: Public API for creating and managing resources in Slant
  contact:
    name: Slant API Support
    email: api@slant.com
servers:
  - url: https://api.slant.app
security:
  - bearer: []
paths:
  /v1/custom_fields:
    get:
      tags:
        - Custom Fields
      summary: List custom_fields
      description: >-
        List all custom fields. book_id is accepted for backwards compatibility
        but ignored.
      parameters:
        - name: page
          in: query
          schema:
            type: integer
          description: Page number
          required: false
          example: 1
        - name: per_page
          in: query
          description: >-
            Items per page (1-100, default: 25). Values over 100 will be clamped
            to 100.
          required: false
          example: 25
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: book_id
          in: query
          description: Deprecated. Ignored.
          required: false
          schema:
            type: string
        - name: entity_type
          in: query
          description: Filter by entity type
          required: false
          schema:
            type: string
            enum:
              - Household
              - Person
              - Contact
              - Opportunity
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - pagination
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomField'
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      total_pages:
                        type: integer
                        example: 10
                      total_count:
                        type: integer
                        example: 100
                      per_page:
                        type: integer
                        example: 25
        '400':
          description: bad request - invalid JSON
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - detail
                properties:
                  error:
                    type: string
                    description: Error code
                    enum:
                      - invalid_json
                  detail:
                    oneOf:
                      - type: string
                        description: Human-readable error description
                      - type: array
                        items:
                          type: string
                        description: Array of validation error messages
        '401':
          description: unauthorized - missing or invalid token
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - detail
                properties:
                  error:
                    type: string
                    description: Error code
                    enum:
                      - token_missing
                      - token_invalid
                  detail:
                    oneOf:
                      - type: string
                        description: Human-readable error description
                      - type: array
                        items:
                          type: string
                        description: Array of validation error messages
        '403':
          description: forbidden
      security:
        - bearer: []
components:
  schemas:
    CustomField:
      type: object
      required:
        - id
        - field_key
        - display_name
        - entity_type
        - field_type
      properties:
        id:
          type: string
          description: The custom field ID
          example: abc123xyz
        field_key:
          type: string
          description: The unique field key
          example: pageport_lead_source
        display_name:
          type: string
          description: The human-readable field name
          example: Lead Source
        entity_type:
          type: string
          description: The entity type this field applies to
          example: Household
          enum:
            - Household
            - Person
            - Contact
            - Opportunity
        field_type:
          type: string
          description: The field data type
          example: text
          enum:
            - text
            - number
            - date
            - boolean
            - single_select
            - multi_select
            - cross_reference
        options:
          type: object
          nullable: true
          description: >-
            Field-specific options (e.g., select_options for select fields,
            cross_reference_allowed_target_types for cross_reference)
          properties:
            select_options:
              type: array
              items:
                type: string
              example:
                - Option 1
                - Option 2
            cross_reference_allowed_target_types:
              type: array
              items:
                type: string
              example:
                - Household
                - Contact
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: OAuth
      description: OAuth 2.0 Bearer Token from Clerk authentication

````