List Agents
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/agent/all \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/agent/all"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/agent/all', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"data": {
"agents": [
{
"id": "00000000-0000-4000-8000-0000000000a1",
"agent_display_name": "EMI reminder",
"agent_type": "outbound",
"orchestration_mode": "single_node",
"created_at": "2026-04-15T10:30:00.000000+00:00",
"updated_at": "2026-04-16T09:12:00.000000+00:00",
"template_name": "<string>",
"template_label": "<string>",
"template_icon": "<string>",
"template_source": "<string>",
"template_type": "outbound",
"versions": [
{
"version_id": "00000000-0000-4000-8000-0000000000d1",
"version_slug": "v1",
"is_archived": false
}
],
"voice_avatar": "<string>",
"call_frequency_cap": {}
}
],
"workspace_call_frequency_cap": {}
}
}{
"message": "Invalid credentials"
}{
"message": "An unexpected error occurred. Please try again later."
}List Agents
List the agents in your workspace with their IDs, display names and types, so your backend can pick the agent_id that calls and campaigns need.
GET
/
agent
/
all
List Agents
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/agent/all \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/agent/all"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/agent/all', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"data": {
"agents": [
{
"id": "00000000-0000-4000-8000-0000000000a1",
"agent_display_name": "EMI reminder",
"agent_type": "outbound",
"orchestration_mode": "single_node",
"created_at": "2026-04-15T10:30:00.000000+00:00",
"updated_at": "2026-04-16T09:12:00.000000+00:00",
"template_name": "<string>",
"template_label": "<string>",
"template_icon": "<string>",
"template_source": "<string>",
"template_type": "outbound",
"versions": [
{
"version_id": "00000000-0000-4000-8000-0000000000d1",
"version_slug": "v1",
"is_archived": false
}
],
"voice_avatar": "<string>",
"call_frequency_cap": {}
}
],
"workspace_call_frequency_cap": {}
}
}{
"message": "Invalid credentials"
}{
"message": "An unexpected error occurred. Please try again later."
}Notes
-
Without
limit, every agent is returned.searchfilters by name. -
Each agent lists its
versions(version_id,version_slug,is_archived). Prompt, voice and other settings are not included; use Get agent. - An agent’s ID does not change when the agent is edited, so look it up once during setup and store it rather than fetching it before every call or campaign.
- For one agent’s full configuration, call Get agent.
Authorizations
Headers
(Required) Your Ringg AI API key.
Example:
"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Query Parameters
Filter agents by name.
Example:
"EMI"
Number of agents to return. Leave it out to get every agent.
Required range:
x >= 1Example:
50
Number of items to skip (default: 0).
Required range:
x >= 0Example:
0
Was this page helpful?