Skip to main content
GET
/
agents
List agents
curl --request GET \
  --url https://app.relyable.ai/api/agents \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "pageCount": 123
  },
  "data": [
    {
      "provider": "VAPI",
      "type": "INBOUND",
      "promptType": "SINGLE",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "apiKey": "<string>",
      "assistantId": "<string>",
      "createdByUserId": "<string>",
      "deletedAt": "<string>",
      "language": "<string>",
      "phoneNumber": "<string>",
      "prompt": "<string>",
      "workspaceId": "<string>",
      "callMonitoring": true,
      "isUsingDefaultApiKey": true,
      "webhookUrl": "<string>",
      "phoneNumberId": "<string>",
      "webhookSecret": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

workspaceId
string
Minimum string length: 1
name
string
provider
enum<string>
Available options:
VAPI,
RETELL,
TIXAE,
ELEVENLABS
page
number
default:1
Required range: x >= 1
limit
number
default:20
Required range: 1 <= x <= 100

Response

Successful response

meta
object
required
data
object[]
required
{key}
any