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

# Get Voice

> Loads a single Voice by id with its background, tone texts and collection counts. Collection contents are not included.



## OpenAPI

````yaml https://api.goextrovert.com/client/v2/docs-json get /client/v2/voices/{id}
openapi: 3.0.0
info:
  title: Extrovert Client API
  description: >-
    Public API for Extrovert platform integration. Use your API key for
    authentication.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.goextrovert.com/
    description: API Server
security: []
tags: []
paths:
  /client/v2/voices/{id}:
    get:
      tags:
        - Voices
      summary: Get Voice
      description: >-
        Loads a single Voice by id with its background, tone texts and
        collection counts. Collection contents are not included.
      operationId: VoiceClientApiController_getById
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetByIdResponseDto'
        '401':
          description: Invalid or missing API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientApiErrorResponseDto'
      security:
        - api-key: []
components:
  schemas:
    GetByIdResponseDto:
      type: object
      properties:
        status:
          type: string
          description: Response status
          enum:
            - success
        data:
          type: object
          description: Loaded Voice
          properties:
            id:
              type: string
              format: uuid
              description: Voice ID
              example: 8d256aa6-9b12-49a7-93ee-bf41634b5b60
            updatedAt:
              type: string
              description: Voice update timestamp
              example: '2025-06-30T14:02:07.456Z'
            createdAt:
              type: string
              description: Voice creation timestamp
              example: '2025-06-30T14:02:07.456Z'
            name:
              type: string
              description: Short human-readable label for the Voice.
            user:
              description: >-
                Reference to the user this Voice belongs to — carries only `id`
                and `name`. Fetch the full user record separately if needed. May
                be missing if the user is no longer available.
              type: object
              properties:
                id:
                  type: string
                  format: uuid
                  description: Stable Extrovert entity ID.
                  example: 8d256aa6-9b12-49a7-93ee-bf41634b5b60
                name:
                  type: string
                  description: Customer-facing entity name.
              required:
                - id
                - name
            isLearningModeEnabled:
              type: boolean
              description: >-
                Whether the Voice is in learning mode. When `true`, the backend
                auto-saves as Comment Examples only those comments the user both
                approved AND edited before approval (unchanged auto-approved
                comments are NOT saved). Only comments are learned — direct
                messages are never auto-saved. The Voice's Comment Examples are
                capped at 20 entries; auto-saved and manual entries share the
                same 20-slot cap. When `false`, no auto-learning happens and
                existing Comment Examples keep being used as-is.
            backgroundAboutUser:
              description: >-
                Free-form plain text about the user themselves — role,
                background, perspective. Used as background when generating
                comments and direct messages, and when analyzing incoming posts.
                Missing while the user has not filled it in.
              type: string
            backgroundAboutCompany:
              description: >-
                Free-form plain text about the user's company, product, market,
                and target audience. Used as background when generating comments
                and direct messages, and when analyzing incoming posts. Missing
                while the user has not filled it in.
              type: string
            instructionsForComments:
              description: >-
                Free-form plain text with tone instructions for comment
                generation (tone, structure, do/don't). Used only when
                generating comments, not direct messages. Missing while the user
                has not filled it in.
              type: string
            instructionsForDm:
              description: >-
                Free-form plain text with tone instructions for direct-message
                generation (tone, structure, do/don't). Used only when
                generating direct messages, not comments. Missing while the user
                has not filled it in.
              type: string
            commentExamplesCount:
              type: integer
              minimum: 0
              maximum: 9007199254740991
              description: Number of approved Comment Examples attached to this Voice.
            talkingPointsCount:
              type: integer
              minimum: 0
              maximum: 9007199254740991
              description: Number of comment Talking Points attached to this Voice.
            sellingPointsCount:
              type: integer
              minimum: 0
              maximum: 9007199254740991
              description: Number of DM Selling Points attached to this Voice.
            dmTemplatesCount:
              type: integer
              minimum: 0
              maximum: 9007199254740991
              description: Number of structured DM Templates attached to this Voice.
        message:
          type: string
          description: Success message
          example: Operation completed successfully
      required:
        - status
        - data
        - message
    ClientApiErrorResponseDto:
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: error
          enum:
            - error
        data:
          type: object
          description: Response data
          example: null
          nullable: true
        message:
          type: string
          description: Error message
          example: An error occurred while processing the request
      required:
        - status
        - data
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key for authentication

````