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

# List custom data fields

> Returns all custom data fields configured for your brand. Use the `field_name` values to populate `custom_data` on user create/update and the `custom_` columns in CSV imports.



## OpenAPI

````yaml /api-reference/openapi.json get /custom_data
openapi: 3.1.0
info:
  title: Sotto API
  version: 1.0.0
  description: >-
    The Sotto API provides programmatic access to manage users, send messages,
    upload files, configure webhooks, and read your segments and custom data
    fields. All requests are authenticated with an HMAC-SHA256 signature. See
    the **Authentication** guide for signing details.
  contact:
    name: Sotto Support
    email: support@bigco.ai
servers:
  - url: https://api.bigco.ai/api/v1
    description: Production
security:
  - hmacSignature: []
tags:
  - name: Users
    description: Create, retrieve, update, and delete users.
  - name: Messages
    description: Send messages to a user.
  - name: Files
    description: Upload media files for use in messages.
  - name: Brand
    description: Retrieve information about your brand.
  - name: Webhooks
    description: Subscribe to and manage event callbacks.
  - name: Segments
    description: Read the audience segments configured for your brand.
  - name: Custom Data
    description: Read the custom data fields configured for your brand.
paths:
  /custom_data:
    get:
      tags:
        - Custom Data
      summary: List custom data fields
      description: >-
        Returns all custom data fields configured for your brand. Use the
        `field_name` values to populate `custom_data` on user create/update and
        the `custom_` columns in CSV imports.
      operationId: getCustomData
      responses:
        '200':
          description: Your brand's custom data fields.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomDataAPI'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    CustomDataAPI:
      type: object
      properties:
        id:
          type:
            - integer
            - 'null'
          example: 42
        field_name:
          type: string
          description: >-
            The custom data field name. Lowercase and snake-case it (and prefix
            with `custom_` for CSV imports) when supplying values.
          example: loyalty_tier
        description:
          type:
            - string
            - 'null'
          example: The customer's loyalty program tier.
        custom_data_type:
          type: integer
          description: >-
            The data type of the field: 1 = INTEGER, 2 = FLOAT, 3 = STRING, 4 =
            LIST, 5 = BOOLEAN, 6 = DATE.
          enum:
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
          example: 3
        subtype:
          type:
            - integer
            - 'null'
          description: For LIST fields, the type code of the list elements.
          example: 3
        available_enum_values:
          type:
            - array
            - 'null'
          items:
            type: string
          description: If set, only these values are accepted for the field.
          example:
            - Bronze
            - Silver
            - Gold
        include_in_ai_prompt:
          type:
            - boolean
            - 'null'
          default: false
        include_user_answers:
          type:
            - boolean
            - 'null'
          default: false
        is_append:
          type:
            - boolean
            - 'null'
          default: false
        is_auto_collected:
          type:
            - boolean
            - 'null'
          default: false
        extraction_prompt:
          type:
            - string
            - 'null'
        is_emphasize_current:
          type:
            - boolean
            - 'null'
          default: true
        is_emphasize_personal:
          type:
            - boolean
            - 'null'
          default: true
      required:
        - field_name
        - custom_data_type
    Error:
      type: object
      properties:
        detail:
          type: object
          properties:
            type:
              type: string
              description: Machine-readable error type.
              example: not_authenticated
            msg:
              type: string
              description: Human-readable error message.
              example: HMAC signature verification failed
          required:
            - type
            - msg
      required:
        - detail
  responses:
    Unauthorized:
      description: Unauthorized — HMAC signature verification failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail:
              type: not_authenticated
              msg: HMAC signature verification failed
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail:
              type: UNCAUGHT_ERROR
              msg: Internal server error
  securitySchemes:
    hmacSignature:
      type: apiKey
      in: header
      name: x-bigco-hmac-sha256
      description: >-
        Base64-encoded HMAC-SHA256 signature of the request. Every request must
        also include the `x-bigco-hmac-username` and `x-date` headers, and
        POST/PUT requests must include `x-digest`. See the Authentication guide
        for the full signing procedure.

````