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

# List contact custom fields

> Retrieves all custom field definitions for contacts. Custom field lists do not paginate. Requires `crm:read` scope.

Retrieves all custom field definitions registered for contacts in your workspace.

> [!NOTE]
>
> Custom-field metadata endpoints do not paginate; they always return the full list of defined fields for this resource type.

### Required permissions

Requires an API key with the `crm:read` scope.


## OpenAPI

````yaml GET /contacts/custom-fields
openapi: 3.1.0
info:
  title: Automate CRM API
  description: >-
    External integration API for Automate CRM. Manage leads, contacts, products,
    follow-ups, custom fields, and real-time inbox lookups.
  version: 1.0.0
servers:
  - url: https://crm-api.automatebusiness.com/api/v1/integrations-public
    description: Production Integration Server
security:
  - apiKeyAuth: []
paths:
  /contacts/custom-fields:
    get:
      summary: List Contact Custom Fields
      description: >-
        Retrieves all custom field definitions for contacts. Custom field lists
        do not paginate. Requires `crm:read` scope.
      operationId: listContactCustomFields
      responses:
        '200':
          description: Contact custom fields retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFieldListResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      security:
        - apiKeyAuth:
            - crm:read
components:
  schemas:
    CustomFieldListResponse:
      allOf:
        - $ref: '#/components/schemas/ReadSuccessEnvelope'
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/CustomFieldDefinition'
    ReadSuccessEnvelope:
      type: object
      description: Standard envelope returned by all GET (read) endpoints
      properties:
        status:
          type: string
          example: success
        code:
          type: integer
          example: 200
        message:
          type: string
          example: Integrations public retrieved successfully
        data:
          description: The returned entity, collection, or payload
        timestamp:
          type: string
          format: date-time
          example: '2026-10-26T10:00:00.000Z'
      required:
        - status
        - code
        - message
        - data
        - timestamp
    CustomFieldDefinition:
      type: object
      properties:
        id:
          type: string
          example: cf_55102a
        entity_type:
          type: string
          enum:
            - lead
            - contact
            - product
          example: lead
        field_name:
          type: string
          example: Expected Close Date
        field_key:
          type: string
          example: expected_close_date
        field_type:
          type: string
          enum:
            - text
            - number
            - date
            - dropdown
            - multi_select
          example: date
        options:
          type: array
          items:
            type: string
          description: Permitted values when field_type is dropdown or multi_select
          example:
            - Bronze
            - Silver
            - Gold
            - Platinum
        is_required:
          type: boolean
          example: false
        created_at:
          type: string
          format: date-time
          example: '2026-10-26T06:00:00.000Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-10-26T06:00:00.000Z'
    ErrorEnvelope:
      type: object
      description: Standard error envelope returned when a request fails
      properties:
        success:
          type: boolean
          example: false
        data:
          type: 'null'
          example: null
        error:
          type: object
          properties:
            message:
              type: string
              example: Validation failed
            details:
              type: array
              items:
                type: object
                properties:
                  message:
                    type: string
                    example: Required
                  field:
                    type: string
                    example: email
                  code:
                    type: string
                    example: invalid_type
          required:
            - message
      required:
        - success
        - data
        - error
  responses:
    UnauthorizedError:
      description: Unauthorized (invalid or missing x-api-key)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            data: null
            error:
              message: Invalid or missing API key.
    ForbiddenError:
      description: Forbidden (API key lacks required crm:read or crm:write scope)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            data: null
            error:
              message: 'Forbidden: insufficient permissions for this operation.'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Workspace API key header. The key implicitly determines your workspace
        isolation. Scopes: `crm:read` for GET/HEAD/OPTIONS, `crm:write` for
        POST/PATCH/PUT/DELETE.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.