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

# List account fields

> Returns account field definitions, including system fields and custom fields. Use `property_name` as the stable key for custom field values.



## OpenAPI

````yaml get /v1/accounts/fields
openapi: 3.1.0
info:
  title: Octolane Public API
  version: 1.0.0
  description: >-
    OpenAPI specification for Octolane public APIs. These endpoints let external
    systems read CRM data and create or update accounts, contacts,
    opportunities, notes, and activities through the public API gateway.
  contact:
    name: Octolane
    url: https://octolane.com
servers:
  - url: https://api.octolane.com
    description: Public API gateway
security:
  - ApiKeyAuth: []
tags:
  - name: CRM
    description: >-
      Public endpoints for creating, bulk creating, listing, searching, and
      updating CRM data.
paths:
  /v1/accounts/fields:
    get:
      tags:
        - CRM
      summary: List account fields
      description: >-
        Returns account field definitions, including system fields and custom
        fields. Use `property_name` as the stable key for custom field values.
      operationId: listAccountFieldsV1
      responses:
        '200':
          description: Account fields were returned.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/FieldsListData'
        '400':
          description: The request failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: >-
            The API key is missing, invalid, or not allowed to access this
            route.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: The route rate limit was exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ApiResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
        data:
          description: Endpoint-specific response payload.
      additionalProperties: true
    FieldsListData:
      type: object
      required:
        - fields
      properties:
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FieldDefinition'
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Validation failed
        statusCode:
          type: integer
          example: 400
      additionalProperties: true
    FieldDefinition:
      type: object
      description: >-
        Field or attribute definition. Account/contact fields use `id`; pipeline
        fields use `attribute_id`. Use `property_name` as the stable API key.
      required:
        - property_name
        - current_name
        - attribute_type
      properties:
        id:
          type: string
          format: uuid
        attribute_id:
          type: string
          format: uuid
        property_name:
          type: string
          example: customer_tier_123
        current_name:
          type: string
          example: Customer Tier
        original_name:
          type: string
          example: Customer Tier
        attribute_type:
          $ref: '#/components/schemas/AttributeType'
        entity_type:
          type: string
          enum:
            - company
            - people
            - opportunity
        pipeline_id:
          type:
            - string
            - 'null'
          format: uuid
        is_editable:
          type: boolean
        is_hidden:
          type: boolean
        is_system:
          type: boolean
        attribute_order:
          type: integer
        metadata:
          oneOf:
            - type: object
              additionalProperties: true
            - type: 'null'
      additionalProperties: true
    AttributeType:
      type: string
      enum:
        - string
        - number
        - checkbox
        - date
        - date_range
        - rating
        - timestamp
        - select
        - multi_select
        - currency
        - percentage
        - location
        - time
        - datetime
        - email
        - phone
        - website
        - url
        - radio
        - team_members
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Public API key for the Octolane organization.

````