> ## 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 Campaign List

> Fetches call campaign data, including status, agent details, calling numbers, and campaign performance metrics.



## OpenAPI

````yaml GET /v2/camp-quickcamp/
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/camp-quickcamp/:
    get:
      description: >-
        Fetches call campaign data, including status, agent details, calling
        numbers, and campaign performance metrics.
      parameters:
        - name: Company-Name
          in: header
          description: The name of the schema to be used for the request
          required: true
          schema:
            type: string
        - name: search
          in: query
          description: The search term used to filter results
          required: false
          schema:
            type: string
        - name: status
          in: query
          description: The status of the campaign (e.g., running, paused, completed)
          required: false
          schema:
            type: string
            enum:
              - running
              - paused
              - completed
        - name: direction
          in: query
          description: The direction of the call (e.g., Outbound or Inbound)
          required: false
          schema:
            type: string
            enum:
              - Outbound
              - Inbound
        - name: sort_by
          in: query
          description: The field by which the results should be sorted (e.g., name, date)
          required: false
          schema:
            type: string
        - name: page
          in: query
          description: The page number to retrieve results from (for pagination)
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: Get Quick Campaign data response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignData'
        '400':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    CampaignData:
      type: object
      properties:
        total_count:
          type: number
          description: Total number of matching campaigns
          example: 257
        total_page:
          type: number
          description: Total number of pages
          example: 6
        Current_page_no:
          type: number
          description: Current page number
          example: 1
        next_page_number:
          type:
            - number
            - 'null'
          description: Next page number if available
          example: 2
        previous_page_number:
          type:
            - number
            - 'null'
          description: Previous page number if available
          example: null
        page_size:
          type: number
          description: Number of items per page
          example: 50
        data:
          type: array
          description: List of campaign items
          items:
            $ref: '#/components/schemas/CampaignItem'
    Error:
      required:
        - success
        - message
        - data
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
    CampaignItem:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the campaign
          example: campdece6857
        name:
          type: string
          description: Name of the campaign
          example: Rell (test)
        direction:
          type: string
          description: Direction of the call campaign
          example: Outbound
        new_agent:
          type:
            - string
            - 'null'
          description: Assigned agent name
          example: Financial
        contact_list:
          type:
            - string
            - 'null'
          description: Reference to the contact list used in the campaign
          example: null
        knowledge_base:
          type:
            - string
            - 'null'
          description: Knowledge base linked to the campaign
          example: null
        calling_number:
          type: string
          description: Primary phone number used for the campaign
          example: '+18446020950'
        status:
          type: string
          description: Current status of the campaign
          example: paused
        total_bugget:
          type: number
          description: Total budget assigned to the campaign
          example: 60
        bugget_left:
          type: string
          description: Remaining budget as a string value
          example: '60.0000'
        status_choices:
          type: array
          description: Possible status options for the campaign
          items:
            type: string
          example:
            - active
            - paused
            - completed
        calling_number_pool:
          type: array
          description: List of available calling numbers
          items:
            type: string
          example:
            - '+17023600026'
            - '+17023600027'
        rotate_number_after_calls:
          type: integer
          description: Number of calls after which the number is rotated
          example: 1
        release_buyed_when:
          type: string
          description: Defines when to release purchased numbers
          example: subscription_complete
        number_rotation:
          type: boolean
          description: Whether number rotation is enabled
          example: false
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
          example: '2025-08-23T10:54:50.133959Z'
        updated_at:
          type: string
          format: date-time
          description: Last updated timestamp
          example: '2025-08-23T15:53:15.089678Z'
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: api_key

````