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

# List Agents



## OpenAPI

````yaml /openapi/openapi.yaml get /v1/agents
openapi: 3.1.0
info:
  title: OneInbox API
  version: 1.0.0
servers:
  - url: https://api.oneinbox.ai
    description: Production server
security: []
tags:
  - name: health
  - name: integrations
  - name: llm-models
  - name: tools
  - name: knowledge-bases
  - name: voices
  - name: webhooks
  - name: agents
  - name: phone-numbers
  - name: calls
  - name: workspace
  - name: usage
  - name: audit-events
paths:
  /v1/agents:
    get:
      tags:
        - agents
      summary: List Agents
      operationId: list_agents_v1_agents_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 20
            title: Limit
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_AgentResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - API Key: []
components:
  schemas:
    PaginatedResponse_AgentResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AgentResponse'
          type: array
          title: Items
        total:
          type: integer
          title: Total
        limit:
          type: integer
          title: Limit
        offset:
          type: integer
          title: Offset
      type: object
      required:
        - items
        - total
        - limit
        - offset
      title: PaginatedResponse[AgentResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AgentResponse:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        llm_id:
          type: string
          title: Llm Id
        webhook_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Webhook Id
        transcriber:
          additionalProperties: true
          type: object
          title: Transcriber
        tts:
          additionalProperties: true
          type: object
          title: Tts
        first_message:
          anyOf:
            - type: string
            - type: 'null'
          title: First Message
        end_call_phrases:
          items:
            type: string
          type: array
          title: End Call Phrases
        max_duration_seconds:
          type: integer
          title: Max Duration Seconds
        interruption_sensitivity:
          type: number
          title: Interruption Sensitivity
        silence_timeout_seconds:
          type: integer
          title: Silence Timeout Seconds
        enable_recording:
          type: boolean
          title: Enable Recording
        language:
          type: string
          title: Language
        dynamic_variables:
          additionalProperties: true
          type: object
          title: Dynamic Variables
        voicemail_detection:
          type: boolean
          title: Voicemail Detection
        voicemail_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Voicemail Message
        responsiveness:
          type: number
          title: Responsiveness
        speed:
          type: number
          title: Speed
        background_sound:
          anyOf:
            - type: string
            - type: 'null'
          title: Background Sound
        emotions:
          type: boolean
          title: Emotions
        job_description:
          anyOf:
            - type: string
            - type: 'null'
          title: Job Description
        effective_system_prompt:
          anyOf:
            - type: string
            - type: 'null'
          title: Effective System Prompt
          description: >-
            Read-only. The system prompt the agent is actually given at call
            time: the linked LLM model's `system_prompt` with `job_description`
            prepended as a `# Role` block — exactly as the worker assembles it.
            Per-call dynamic-variable interpolation and knowledge-base chunks
            are resolved at runtime and not reflected here. Populated on GET
            /v1/agents/{id}; null on list responses.
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - id
        - name
        - llm_id
        - webhook_id
        - transcriber
        - tts
        - first_message
        - end_call_phrases
        - max_duration_seconds
        - interruption_sensitivity
        - silence_timeout_seconds
        - enable_recording
        - language
        - dynamic_variables
        - voicemail_detection
        - voicemail_message
        - responsiveness
        - speed
        - background_sound
        - emotions
        - job_description
        - metadata
        - created_at
        - updated_at
      title: AgentResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    API Key:
      type: http
      description: >-
        Your **API key** sent as a Bearer credential — `Authorization: Bearer
        <api_key>`, where `<api_key>` starts with `oi_sk_` (create one via `POST
        /v1/api-keys`). Although the field is labelled 'token', paste your API
        key here. A dashboard JWT is also accepted on this header for the same
        endpoints.
      scheme: bearer

````