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

# Get custom field definitions

> List the custom field definitions configured for invoices, including their id, key, type and — for select and multi-select fields — their available options. Use the returned id or key to address a field when writing to an invoice's custom fields.



## OpenAPI

````yaml get /v1/custom-fields/definitions
openapi: 3.0.0
info:
  title: ibana public api
  description: Public API for ibana
  version: 1.0.0
  contact:
    name: ibana
    url: https://ibana.io
    email: dev@ibana.io
servers:
  - url: https://public-api.ibana.io
    description: Production
security: []
tags: []
paths:
  /v1/custom-fields/definitions:
    get:
      tags:
        - Custom Fields
      summary: Get custom field definitions
      description: >-
        List the custom field definitions configured for invoices, including
        their id, key, type and — for select and multi-select fields — their
        available options. Use the returned id or key to address a field when
        writing to an invoice's custom fields.
      operationId: CustomFieldController_getDefinitions_v1
      parameters:
        - name: includeArchived
          required: false
          in: query
          description: Include archived definitions. Defaults to false.
          schema:
            type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomFieldDefinitionResponseDto'
      security:
        - bearer: []
components:
  schemas:
    CustomFieldDefinitionResponseDto:
      type: object
      properties:
        id:
          type: string
        organizationId:
          type: string
        entityType:
          type: string
          enum:
            - INVOICE
            - AR_INVOICE
            - COUNTERPARTY
        key:
          type: string
        label:
          type: string
        description:
          type: string
          nullable: true
        type:
          type: string
          enum:
            - NUMBER
            - STRING
            - SELECT
            - MULTI_SELECT
            - CHECKBOX
        options:
          type: array
        sortOrder:
          type: number
        archivedAt:
          type: object
          nullable: true
      required:
        - id
        - organizationId
        - entityType
        - key
        - label
        - type
        - options
        - sortOrder
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````