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

# List Custom Field Schema

> Lists every custom field this client can read or write, with its type (text, number, date, dropdown_singleselect, dropdown_multiselect), dropdown options and whether the agency master schema or the client defines it.



## OpenAPI

````yaml GET /public/custom-fields/schema
openapi: 3.0.3
info:
  title: RevyOps API
  version: 1.0.0
servers:
  - url: https://app.revyops.com/api
security:
  - ApiKeyAuth: []
paths:
  /public/custom-fields/schema:
    get:
      tags:
        - public
      description: >-
        Lists every custom field this client can read or write, with its type
        (text, number, date, dropdown_singleselect, dropdown_multiselect),
        dropdown options and whether the agency master schema or the client
        defines it.
      operationId: List custom field definitions
      parameters:
        - in: query
          name: object
          schema:
            type: string
          description: contact or company
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomFieldDefinitionRow'
          description: ''
components:
  schemas:
    CustomFieldDefinitionRow:
      type: object
      properties:
        object:
          $ref: '#/components/schemas/ObjectEnum'
        field_name:
          type: string
        type:
          $ref: '#/components/schemas/TypeEnum'
        available_options:
          type: array
          items:
            type: string
        source:
          allOf:
            - $ref: '#/components/schemas/SourceEnum'
          description: >-
            agency: defined in the agency master schema, its type is managed
            there; client: defined for this workspace only.


            * `agency` - agency

            * `client` - client
        created_by:
          type: string
          nullable: true
          description: >-
            Firebase uid of the user who added it in the UI; null for fields
            created by the API, MCP or an import.
        filter_key:
          type: string
          description: The field id to use in filter conditions, e.g. custom.fit_score.
      required:
        - available_options
        - created_by
        - field_name
        - filter_key
        - object
        - source
        - type
    ObjectEnum:
      enum:
        - contact
        - company
      type: string
      description: |-
        * `contact` - contact
        * `company` - company
    TypeEnum:
      enum:
        - text
        - number
        - date
        - dropdown_singleselect
        - dropdown_multiselect
      type: string
      description: |-
        * `text` - text
        * `number` - number
        * `date` - date
        * `dropdown_singleselect` - dropdown_singleselect
        * `dropdown_multiselect` - dropdown_multiselect
    SourceEnum:
      enum:
        - agency
        - client
      type: string
      description: |-
        * `agency` - agency
        * `client` - client
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````