Skip to main content
GET
/
agents
List agents
curl --request GET \
  --url https://app2.freyavoice.ai/api/v2/agents \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "message": "<string>",
    "result": {
      "agents": [
        {
          "id": "<string>",
          "name": "<string>",
          "source": "firebase",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "total": 1,
      "limit": 123,
      "offset": 1
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
workspaceId
string<uuid>
required

Workspace ID

​
source
enum<string>
default:all

Filter by agent source

Available options:
firebase,
vapi,
all
​
limit
integer
default:50

Maximum number of agents to return (1-100)

Required range: x <= 100
​
offset
integer
default:0

Number of agents to skip for pagination

Required range: x >= 0

Response

Agents list with pagination

​
success
enum<boolean>
required
Available options:
true,
false
​
data
object
required