Skip to main content

​
Request

​
organization_id
integer
required
Your organization ID
​
api_key
string
required
Your organization API key
​
status
string
Filter by agent status (active, draft, paused)
​
limit
integer
default:"100"
Maximum number of agents to return
​
offset
integer
default:"0"
Number of records to skip for pagination

​
Examples

curl -X GET 'https://www.tabbly.io/dashboard/agents/endpoints/get-agents?organization_id=244&api_key=your_api_key&status=active' \
-H 'Content-Type: application/json'

​
Response

​
success
boolean
Indicates if the request was successful
​
agents
array
Array of agent objects
​
total
integer
Total number of agents

​
Agent Object

​
agent_id
integer
Unique identifier for the agent
​
agent_name
string
Name of the agent
​
agent_description
string
Description of the agent
​
status
string
Status of the agent (active, draft, paused)
​
voice_id
integer
ID of the voice used by the agent
​
language
string
Primary language code
​
created_at
string
Timestamp when the agent was created
​
updated_at
string
Timestamp when the agent was last updated

​
Success Response (200 OK)

{
    "success": true,
    "agents": [
        {
            "agent_id": 33,
            "agent_name": "Customer Support Agent",
            "agent_description": "Handles customer support inquiries",
            "status": "active",
            "voice_id": 5,
            "language": "en",
            "created_at": "2025-01-01T10:00:00Z",
            "updated_at": "2025-01-15T14:30:00Z"
        }
    ],
    "total": 5
}

​
Error Responses

​
400
object
Missing required fields
​
404
object
Organization not found
​
500
object
Server error