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

# List Agents

> Fetch a paginated list of all agents in a project



## OpenAPI

````yaml /api-reference/openapi.json get /v1/bot/readall
openapi: 3.0.0
info:
  title: BoostGPT API
  version: 1.0.0
  description: API for managing AI agents with memory capabilities
servers:
  - url: https://api.boostgpt.co
    description: Production server
security:
  - BearerAuth: []
tags:
  - name: Agent
    description: Operations for managing AI agents
  - name: Memory
    description: Operations for managing agent memory sources
  - name: Chat
    description: Operations for chatting with agents and managing conversations
  - name: Subscribers
    description: Operations for managing subscribers and leads
  - name: Tools
    description: Operations for managing agent tools and MCP server integrations
  - name: Analytics
    description: Operations for retrieving agent statistics and analytics
  - name: Heartbeat
    description: Operations for managing autonomous agent scheduling and execution
  - name: User Memory
    description: Operations for managing per-user memory entries
  - name: Email
    description: Operations for managing agent email functionality
  - name: Triggers
    description: Operations for firing proactive agent trigger events
  - name: CRM
    description: >-
      Operations for managing agent CRM contacts, pipelines, deals, follow-ups,
      and reports
  - name: Workflows
    description: Operations for managing agent workflow automations
  - name: Calendar
    description: Operations for managing agent calendar settings, availability, and events
  - name: Workspace
    description: Operations for managing agent workspaces and files
paths:
  /v1/bot/readall:
    get:
      tags:
        - Agent
      summary: List Agents
      description: Fetch a paginated list of all agents in a project
      parameters:
        - name: project_id
          in: query
          required: true
          schema:
            type: string
          description: Project ID
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
          description: Page number
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            default: 10
          description: Items per page
      responses:
        '200':
          description: Agents retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentListResponse'
components:
  schemas:
    AgentListResponse:
      type: object
      properties:
        bots:
          type: array
          items:
            $ref: '#/components/schemas/BotObject'
        pagination:
          $ref: '#/components/schemas/Pagination'
    BotObject:
      type: object
      description: Agent/Bot object (used in list responses)
      properties:
        id:
          type: string
          description: Agent unique identifier
        uuid:
          type: string
          description: Agent unique identifier
        subdomain:
          type: string
          description: Agent subdomain
        provider_key:
          type: string
          nullable: true
          description: AI provider API key
        avatar:
          type: string
          nullable: true
          description: Agent avatar filename
        name:
          type: string
          description: Agent name
        model:
          type: string
          description: AI model being used
        reasoning_type:
          type: string
          description: Default reasoning type for the agent
        max_reply_tokens:
          type: string
          description: Maximum reply tokens
        top:
          type: integer
          description: Number of top memory results to use
        instruction:
          type: string
          description: System instructions for the agent
        ratelimit_message:
          type: string
          nullable: true
          description: Custom rate limit message
        ratelimit_seconds:
          type: integer
          description: Rate limit time window in seconds
        ratelimit_requests:
          type: integer
          description: Maximum requests per time window
        no_answer_reply:
          type: string
          description: Default reply when agent has no answer
        require_login:
          type: integer
          description: Whether login is required (0 = no, 1 = yes)
        memory:
          type: integer
          description: Whether memory is enabled (0 = no, 1 = yes)
        heartbeat:
          type: integer
          description: >-
            Whether heartbeat (autonomous scheduling) is enabled (0 = no, 1 =
            yes)
        hide_branding:
          type: integer
          description: Whether to hide branding (0 = no, 1 = yes)
        branding:
          type: object
          description: Agent branding configuration
          properties:
            seo:
              type: object
              properties:
                title:
                  type: string
                  description: SEO title
                keywords:
                  type: string
                  description: SEO keywords
                description:
                  type: string
                  description: SEO description
            logo:
              type: object
              properties:
                url:
                  type: string
                  nullable: true
                  description: Logo URL
                enabled:
                  type: boolean
                  description: Whether logo is enabled
            theme:
              type: string
              description: UI theme (e.g., light, dark)
            favicon:
              type: object
              properties:
                url:
                  type: string
                  nullable: true
                  description: Favicon URL
                enabled:
                  type: boolean
                  description: Whether favicon is enabled
            tagline:
              type: object
              properties:
                content:
                  type: string
                  description: Tagline text
                enabled:
                  type: boolean
                  description: Whether tagline is enabled
            navigation:
              type: object
              properties:
                links:
                  type: array
                  items:
                    type: object
                  description: Navigation links
                enabled:
                  type: boolean
                  description: Whether navigation is enabled
            description:
              type: object
              properties:
                content:
                  type: string
                  description: Description text
                enabled:
                  type: boolean
                  description: Whether description is enabled
            placeholder:
              type: string
              description: Input placeholder text
            accent_color:
              type: string
              description: Accent color hex code
            background_color:
              type: string
              description: Background color hex code
            message_greetings:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Whether message greetings are enabled
                greetings:
                  type: array
                  items:
                    type: string
                  description: List of greeting messages
            conversation_starters:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Whether conversation starters are enabled
                prompts:
                  type: array
                  items:
                    type: string
                  description: List of conversation starter prompts
        status:
          type: integer
          description: Agent status (0 = inactive, 1 = active)
        active_at:
          type: string
          format: date-time
          description: Last active timestamp
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp
        integrations:
          type: array
          items:
            type: object
          description: List of enabled integrations
        avatar_link:
          type: string
          description: Full avatar URL
        domain:
          type: string
          description: Agent's public domain URL
    Pagination:
      type: object
      properties:
        page:
          type: integer
          description: Current page number
        per_page:
          type: integer
          description: Items per page
        total:
          type: integer
          description: Total number of items
        total_pages:
          type: integer
          description: Total number of pages
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Enter your API key

````