Agent Management→List Agents
List Agents
Retrieve a list of all agents in your account. Results are paginated and can be filtered by agent type.
GET
https://api.sparkco.ai/api/v1/agents
Query Parameters
| Name | Type | Description |
|---|---|---|
| page | integer | Page number for pagination (default: 1) |
| limit | integer | Number of items per page (default: 10, max: 100) |
| agent_type | string | Filter by agent type (professional/companion/custom) |
Example Request
curl "https://api.sparkco.ai/api/v1/agents?page=1&limit=10&agent_type=professional" \
-H "X-API-Key: your-api-key"Response
{
"success": true,
"data": [
{
"id": 1,
"agent_name": "Customer Service Bot",
"agent_purpose": "Handle customer inquiries",
"initial_instructions": "You are a helpful customer service agent",
"agent_instructions": "Always greet customers warmly",
"agent_type": "professional",
"communication_type": "phonecall",
"gender": "female",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z",
"created_by": "user_id",
"updated_by": "user_id"
}
],
"pagination": {
"total": 10,
"page": 1,
"limit": 10,
"total_pages": 1,
"has_more": false
}
}