Skip to main content
GET
/
agent
/
all
Get Assistants
curl --request GET \
  --url https://prod-api.ringg.ai/ca/api/v0/agent/all \
  --header 'X-API-KEY: <x-api-key>'
{
  "status": "<string>",
  "data": {
    "agents": [
      {
        "id": "830f767a-397e-4b39-82ff-235cd344e2f9",
        "agent_display_name": "Sales Assistant",
        "agent_type": "outbound",
        "created_at": "2024-12-16T13:03:29.947147+00:00",
        "updated_at": "2024-12-16T14:15:32.123456+00:00",
        "template_name": "sales",
        "template_label": "Sales Agent",
        "template_icon": "💼",
        "template_source": "custom",
        "call_count": 47,
        "custom_variables": {
          "callee_name": "string",
          "mobile_number": "string",
          "company": "string",
          "lead_source": "string"
        },
        "tools": [],
        "is_archived": false,
        "secondary_language": "hi-IN",
        "secondary_voice_id": "4c6d8e3b-9f0a-5b2c-ad7e-3f6a9b8c5d7e",
        "template_type": "outbound"
      }
    ]
  }
}
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.

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Query Parameters

​
limit
integer
default:10

Number of items to return (default: 20, max: 100).

Example:

50

​
offset
integer
default:0

Number of items to skip (default: 0).

Example:

20

Response

Successful Response: A list of assistants.

​
status
string
​
data
object