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

# List Custom Object Types

> Returns the list of custom object types configured for the company. Use
the `type` value from the response as the `objectType` path parameter
for all other custom object endpoints.

**Required permission:** `company.fmv1_custom_object:read`




## OpenAPI

````yaml /openapi/generated-external-api.yaml get /api/v1/external/companies/{companyId}/custom-objects
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://app.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/external/companies/{companyId}/custom-objects:
    get:
      tags:
        - Field Model Custom Objects
      summary: List Custom Object Types
      description: |
        Returns the list of custom object types configured for the company. Use
        the `type` value from the response as the `objectType` path parameter
        for all other custom object endpoints.

        **Required permission:** `company.fmv1_custom_object:read`
      operationId: listCustomObjectTypes
      parameters:
        - $ref: '#/components/parameters/companyId'
      responses:
        '200':
          description: List of custom object types
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomObjectTypeItem'
              examples:
                success:
                  summary: Company with custom object types
                  value:
                    items:
                      - id: 550e8400-e29b-41d4-a716-446655440010
                        type: vehicle
                        displayNameExpression: vehicleMake + vehicleModel
                      - id: 550e8400-e29b-41d4-a716-446655440011
                        type: building_info
                        displayNameExpression: null
                empty:
                  summary: No custom object types configured
                  value:
                    items: []
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
  schemas:
    CustomObjectTypeItem:
      type: object
      description: A custom object type definition available for the company.
      required:
        - id
        - type
        - displayNameExpression
      properties:
        id:
          type: string
          description: Custom object type identifier
        type:
          type: string
          description: >-
            The object type in snake_case format (e.g., `vehicle`,
            `building_info`)
        displayNameExpression:
          type: string
          nullable: true
          description: |
            Expression used to compute the display name from field values.
            Null if no display name expression is configured.
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error message
              example: 'submissionId: Required field is missing'
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: UNAUTHORIZED
                  message: Authorization header is required
            bearerTokenNotAllowed:
              summary: Bearer token used instead of API key
              value:
                error:
                  code: UNAUTHORIZED
                  message: External API endpoints require API key authentication
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: FORBIDDEN
                  message: Insufficient permissions to perform this action
    InternalServerError:
      description: Internal Server Error - Unexpected error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                error:
                  code: INTERNAL_ERROR
                  message: An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Include your API key in the Authorization
        header.

````