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

# Get Agent List

> Retrieves a paginated list of AI call agents with optional search and sorting



## OpenAPI

````yaml GET /v2/aicallagent-list/
openapi: 3.1.0
info:
  title: CloserX.ai API
  description: >-
    The CloserX.ai API provides programmatic access to manage AI-powered calling
    operations, including agent creation, campaign management, contact handling,
    telephony integration, and more. This API enables seamless automation and
    integration with CRM systems, telephony providers, and other third-party
    services for enhanced client communication and business operations.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://app.closerx.ai/api
security:
  - api_key: []
paths:
  /v2/aicallagent-list/:
    get:
      description: >-
        Retrieves a paginated list of AI call agents with optional search and
        sorting
      parameters:
        - name: Company-Name
          in: header
          description: The name of the schema to be used for the request
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: Page number for pagination
          required: false
          schema:
            type: integer
            default: 1
        - name: search
          in: query
          description: Search term to filter agents
          required: false
          schema:
            type: string
            default: ''
        - name: sort_by
          in: query
          description: Field to sort by (prefix with '-' for descending order)
          required: false
          schema:
            type: string
            default: '-updated_at'
      responses:
        '200':
          description: AI call agents list response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AICallAgentListResponse'
        '400':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AICallAgentListResponse:
      type: object
      required:
        - total_count
        - total_page
        - Current_page_no
        - next_page_number
        - previous_page_number
        - page_size
        - data
      properties:
        total_count:
          type: integer
          description: Total number of AI call agents
        total_page:
          type: integer
          description: Total number of pages
        Current_page_no:
          type: integer
          description: Current page number
        next_page_number:
          type: integer
          nullable: true
          description: Next page number, null if no next page
        previous_page_number:
          type: string
          nullable: true
          description: Previous page number, null if no previous page
        page_size:
          type: integer
          description: Number of agents per page
        data:
          type: array
          description: List of AI call agents
          items:
            type: object
            required:
              - pk
              - agent_name
              - agent_id
              - voice_id
              - language
              - interruption_sensitivity
              - voicemail
              - voicemail_message
              - end_call_after_silence
              - max_call_duration
              - reminder_trigger
              - ambient_sound
              - analysis_data
              - llm
              - voice_speed
              - voice_temperature
              - volume
              - enable_backchannel
              - normalize_for_speech
              - enable_transcription_formatting
              - reminder_trigger_ms
              - reminder_max_count
              - boosted_keywords
              - ambient_sound_volume
              - voicemail_detection_timeout_ms
              - begin_message_delay_ms
              - updated_at
              - is_locked
              - calendar_id
              - inbound_appoitment
              - ring_duration_sec
              - stt_mode
              - backchannel_words
              - backchannel_frequency
              - call_scheduling
              - agent_crm_type
              - voicemail_option
            properties:
              pk:
                type: integer
                description: Primary key for the AI call agent
              agent_name:
                type: string
                description: Name of the AI call agent
              agent_id:
                type: string
                description: Unique identifier for the AI call agent
              voice_id:
                type: string
                description: Identifier for the voice used by the agent
              language:
                type: string
                description: Language code or type (e.g., en-US, multi)
              interruption_sensitivity:
                type: string
                description: Sensitivity level for interruptions
              voicemail:
                type: boolean
                description: Indicates if voicemail is enabled
              voicemail_message:
                type: string
                nullable: true
                description: Voicemail message content
              end_call_after_silence:
                type: integer
                description: Duration of silence before ending the call (in seconds)
              max_call_duration:
                type: integer
                description: Maximum call duration (in minutes)
              reminder_trigger:
                type: integer
                description: Time before triggering a reminder (in seconds)
              ambient_sound:
                type: string
                nullable: true
                description: Ambient sound setting
              analysis_data:
                type: array
                description: Data for call analysis
                items:
                  type: string
              llm:
                type: integer
                description: Identifier for the language model used
              voice_speed:
                type: number
                format: float
                description: Speed of the voice
              voice_temperature:
                type: number
                format: float
                description: Temperature setting for voice generation
              volume:
                type: number
                format: float
                description: Volume level for the voice
              enable_backchannel:
                type: boolean
                description: Indicates if backchannel responses are enabled
              normalize_for_speech:
                type: boolean
                description: Indicates if speech normalization is enabled
              enable_transcription_formatting:
                type: boolean
                description: Indicates if transcription formatting is enabled
              reminder_trigger_ms:
                type: integer
                description: Reminder trigger time in milliseconds
              reminder_max_count:
                type: integer
                description: Maximum number of reminders
              boosted_keywords:
                type: array
                description: List of keywords to boost in processing
                items:
                  type: string
              ambient_sound_volume:
                type: number
                format: float
                description: Volume level for ambient sound
              voicemail_detection_timeout_ms:
                type: integer
                description: Timeout for voicemail detection in milliseconds
              begin_message_delay_ms:
                type: integer
                description: Delay before starting message in milliseconds
              updated_at:
                type: string
                format: date-time
                description: Timestamp when the agent was last updated
              is_locked:
                type: boolean
                description: Indicates if the agent is locked
              calendar_id:
                type: string
                nullable: true
                description: Identifier for associated calendar
              inbound_appoitment:
                type: boolean
                description: Indicates if inbound appointment scheduling is enabled
              ring_duration_sec:
                type: integer
                description: Ring duration in seconds
              stt_mode:
                type: string
                description: Speech-to-text mode (e.g., fast)
              backchannel_words:
                type: string
                nullable: true
                description: Words used for backchannel responses
              backchannel_frequency:
                type: number
                format: float
                description: Frequency of backchannel responses
              call_scheduling:
                type: boolean
                description: Indicates if call scheduling is enabled
              agent_crm_type:
                type: string
                nullable: true
                description: Type of CRM integration for the agent
              voicemail_option:
                type: object
                description: Voicemail options for the agent
                properties:
                  action:
                    type: object
                    properties:
                      type:
                        type: string
                        description: Type of voicemail action (e.g., hangup, prompt)
                      text:
                        type: string
                        description: Text for voicemail prompt, if applicable
    Error:
      required:
        - success
        - message
        - data
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: api_key

````