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

# List custom fields



## OpenAPI

````yaml /api-reference/openapi.json get /v1/custom-fields
openapi: 3.0.0
info:
  title: Flovoo API
  description: |-
    Authenticate with an API key created from **Connectors → API**:

    ```
    Authorization: Bearer flv_...
    ```

    The organization is derived from the key, so no request carries an
    organization id.
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /v1/custom-fields:
    get:
      tags:
        - Custom Fields
      summary: List custom fields
      operationId: PublicCustomFieldsController_list
      parameters:
        - name: status
          required: false
          in: query
          schema:
            type: string
            enum:
              - ACTIVE
              - ARCHIVED
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicCustomFieldListDoc'
        '401':
          description: The key is missing, unknown, or revoked.
          content:
            application/json:
              examples:
                missing:
                  summary: No Authorization header
                  value:
                    error:
                      type: authentication_error
                      code: missing_api_key
                      message: No API key was provided.
                      requestId: req_01J8X4M2N9P3Q5R7
                invalid:
                  summary: Unknown key
                  value:
                    error:
                      type: authentication_error
                      code: invalid_api_key
                      message: The API key provided is not valid.
                      requestId: req_01J8X4M2N9P3Q5R7
                revoked:
                  summary: Revoked key
                  value:
                    error:
                      type: authentication_error
                      code: revoked_api_key
                      message: This API key has been revoked.
                      requestId: req_01J8X4M2N9P3Q5R7
        '403':
          description: The key is valid but lacks the route's scope.
          content:
            application/json:
              example:
                error:
                  type: permission_error
                  code: insufficient_scope
                  message: >-
                    This API key does not have the required scope:
                    contacts.create.
                  requestId: req_01J8X4M2N9P3Q5R7
        '429':
          description: Rate limit exceeded. `Retry-After` gives the seconds to wait.
          content:
            application/json:
              example:
                error:
                  type: rate_limit_error
                  code: rate_limit_exceeded
                  message: >-
                    Rate limit of 300 requests per minute exceeded. Retry in
                    23s.
                  requestId: req_01J8X4M2N9P3Q5R7
        '500':
          description: >-
            An error on our side. The original exception is never returned;
            quote `requestId` to support.
          content:
            application/json:
              example:
                error:
                  type: api_error
                  code: internal_error
                  message: An unexpected error occurred.
                  requestId: req_01J8X4M2N9P3Q5R7
      security:
        - api-key: []
components:
  schemas:
    PublicCustomFieldListDoc:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type: string
              fieldKey:
                type: string
              type:
                type: string
                enum:
                  - TEXT
                  - SINGLE_SELECT
                  - MULTI_SELECT
                  - URL
                x-enumNames:
                  - TEXT
                  - SINGLE_SELECT
                  - MULTI_SELECT
                  - URL
              description:
                type: string
                nullable: true
              status:
                type: string
                enum:
                  - ACTIVE
                  - ARCHIVED
              options:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                    label:
                      type: string
                    color:
                      type: string
                    sortOrder:
                      type: integer
                  required:
                    - id
                    - label
                    - color
                    - sortOrder
              createdAt:
                type: string
                format: date-time
              updatedAt:
                type: string
                format: date-time
            required:
              - id
              - name
              - fieldKey
              - type
              - description
              - status
              - options
              - createdAt
              - updatedAt
      required:
        - data
  securitySchemes:
    api-key:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Your API key, e.g. flv_9f2a8c1e…

````