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

# Get Assistants

> Retrieves a list of all available assistants in your workspace.

List assistants in the workspace. Most integrations call this during setup so an operator can choose which assistant should handle calls.

## When to use

* Populate an assistant picker in your internal admin UI.
* Find the `agent_id` required by outbound call and campaign APIs.
* Filter for assistants configured for the channel you are integrating, such as outbound calls or web calls.

## Integration notes

* Store the selected `agent_id` in your database rather than looking it up before every call.
* If an assistant is edited in the dashboard, its ID remains the stable integration handle.
* Use `GET /agent/{agent_id}` when you need details for one assistant.


## OpenAPI

````yaml get /agent/all
openapi: 3.0.0
info:
  title: Ringg AI API Documentation
  description: >-
    This is the documentation for the Ringg AI APIs. The Ringg AI API follows
    RESTful principles, making it intuitive and easy to integrate with your
    applications. All API requests should be made to the base URL. The API
    accepts and returns data in JSON format. Ensure your requests include the
    appropriate Content-Type header for POST and PATCH requests.
  version: 2.0.0
servers:
  - url: https://prod-api.ringg.ai/ca/api/v0
security: []
tags:
  - name: workspace
    description: Endpoints for managing your workspace.
  - name: agent
    description: Endpoints for managing assistants (agents).
  - name: calling
    description: Endpoints for making and managing calls.
  - name: campaign
    description: Endpoints for managing campaigns.
  - name: analytics
    description: Endpoints for accessing call analytics and performance metrics.
  - name: termination
    description: Endpoints for terminating active calls using different methods.
  - name: knowledgebase
    description: Endpoints for managing knowledge bases.
paths:
  /agent/all:
    get:
      tags:
        - agent
      summary: Get Assistants
      description: Retrieves a list of all available assistants in your workspace.
      operationId: getAssistants
      parameters:
        - name: X-API-KEY
          in: header
          description: (Required) Your Ringg AI API key.
          required: true
          schema:
            type: string
            example: 7251cb4b-3373-43a4-844c-b27a1d45e0c9
        - name: limit
          in: query
          description: 'Number of items to return (default: 20, max: 100).'
          schema:
            type: integer
            default: 10
            example: 50
        - name: offset
          in: query
          description: 'Number of items to skip (default: 0).'
          schema:
            type: integer
            default: 0
            example: 20
      responses:
        '200':
          description: 'Successful Response: A list of assistants.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  data:
                    type: object
                    properties:
                      agents:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 830f767a-397e-4b39-82ff-235cd344e2f9
                            agent_display_name:
                              type: string
                              example: Sales Assistant
                            agent_type:
                              type: string
                              example: outbound
                            created_at:
                              type: string
                              format: date-time
                              example: '2024-12-16T13:03:29.947147+00:00'
                            updated_at:
                              type: string
                              format: date-time
                              example: '2024-12-16T14:15:32.123456+00:00'
                            template_name:
                              type: string
                              example: sales
                            template_label:
                              type: string
                              example: Sales Agent
                            template_icon:
                              type: string
                              example: 💼
                            template_source:
                              type: string
                              example: custom
                            call_count:
                              type: integer
                              example: 47
                            custom_variables:
                              type: object
                              example:
                                callee_name: string
                                mobile_number: string
                                company: string
                                lead_source: string
                            tools:
                              type: array
                              items:
                                type: object
                              example: []
                            is_archived:
                              type: boolean
                              example: false
                            secondary_language:
                              type: string
                              nullable: true
                              example: hi-IN
                            secondary_voice_id:
                              type: string
                              nullable: true
                              example: 4c6d8e3b-9f0a-5b2c-ad7e-3f6a9b8c5d7e
                            template_type:
                              type: string
                              example: outbound
        '401':
          description: Unauthorized - Invalid or missing API key.
        '500':
          description: Internal Server Error - Something went wrong on our end.

````