Skip to main content
GET
/
agents
List Agents
curl --request GET \
  --url https://api.revring.ai/v1/agents \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.revring.ai/v1/agents"

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://api.revring.ai/v1/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.revring.ai/v1/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.revring.ai/v1/agents"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.revring.ai/v1/agents")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.revring.ai/v1/agents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "promptTemplate": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "messagingConnectionId": "<string>",
      "messagingConfig": {
        "smsPrompt": "<string>",
        "inboundWebhookUrl": "<string>",
        "fromNumber": "<string>",
        "sendMessageEnabled": true,
        "sendMessageDescriptionOverride": "<string>",
        "conversationIdleResetDays": 123
      },
      "widgetKey": "<string>",
      "widgetConfig": {
        "enabled": true,
        "modes": {
          "chat": true,
          "voice": true
        },
        "continuity": {
          "resumeCalls": true,
          "sharedMemory": true
        },
        "allowedDomains": [
          "<string>"
        ],
        "webchatPrompt": "<string>",
        "appearance": {
          "accentColor": "<string>",
          "launcherLabel": "<string>",
          "agentDisplayName": "<string>",
          "avatarUrl": "<string>",
          "welcomeMessage": "<string>",
          "chatPlaceholder": "<string>"
        },
        "limits": {
          "messagesPerDay": 123
        }
      },
      "sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sipTrunk": {
        "friendlyName": "<string>"
      },
      "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "folder": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "color": "<string>"
      },
      "defaultVariables": {},
      "firstMessage": "<string>",
      "turnTimeoutSeconds": 123,
      "silenceEndCallTimeoutSeconds": 123,
      "maxConversationDurationSeconds": 123,
      "llmTemperature": 1,
      "timezone": "<string>",
      "language": "<string>",
      "preCallWebhookUrl": "<string>",
      "postCallWebhookUrl": "<string>",
      "endCallEnabled": true,
      "endCallRulesOverride": "<string>",
      "transferEnabled": true,
      "transferRoutes": [
        {
          "to_number": "<string>",
          "condition": "<string>",
          "extension": "<string>"
        }
      ],
      "transferDescriptionOverride": "<string>",
      "voicemailEnabled": true,
      "voicemailMessage": "<string>",
      "voiceId": "<string>",
      "voiceTemperature": 0.5,
      "voiceSpeed": 1.25,
      "voiceVolume": 0,
      "voiceTopP": 0.5,
      "runtimeConfig": {},
      "phoneNumbers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "e164": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "customTools": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "webhookUrl": "<string>",
          "enabled": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "schema": {},
          "headers": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "queryParams": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "sendRawRequestBody": true
        }
      ],
      "flowDefinition": {},
      "testVariables": {},
      "disableInterruptions": true,
      "interruptionThresholdMs": 500,
      "warmTransferConfig": {
        "holdMessage": "<string>",
        "holdMusicEnabled": true,
        "summaryPrompt": "<string>",
        "introMessage": "<string>",
        "continueRecordingAfterTransfer": true
      },
      "playKeypadTouchToneEnabled": true,
      "playKeypadTouchToneDescriptionOverride": "<string>",
      "knowledgeBaseChunks": 10,
      "knowledgeBaseSimilarityThreshold": 0.5
    }
  ],
  "page": 2,
  "pageSize": 50,
  "total": 123,
  "hasNextPage": true
}
{
"error": "invalid_body",
"details": {}
}
{
"error": "unauthorized"
}
{
"error": "billing_inactive"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard.

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
pageSize
integer
default:25

Items per page

Required range: 1 <= x <= 100
sortBy
enum<string>
default:createdAt

Sort field

Available options:
createdAt,
updatedAt,
name
sortDir
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
status
enum<string>

Filter by status

Available options:
active,
disabled
folderId
string

Filter by folder. Pass a folder ID to only return agents in that folder, or none to only return agents not in any folder. Omit to return agents from all folders.

q
string

Search agents by name (case-insensitive substring match)

Maximum string length: 128
minimal
boolean
default:false

Return a compact representation, omitting prompt template, flow definition, variables, runtime config, custom tools, and knowledge bases

Response

Paginated list of agents

Paginated list of agents

data
object[]
required

Array of agents on the current page

page
integer
required
Required range: x >= 1
pageSize
integer
required
Required range: 1 <= x <= 100
total
integer
required
hasNextPage
boolean
required