Lists campaigns
GET/api/v1/campaigns
- Scope
read- SDK method
- listCampaigns · list_campaigns
- MCP tool
listCampaignsread-only
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
bot_idquery | uuid | no | This bot only |
statusquery | enum | no | Status filter; any other value returns 400draft | pending_approval | approved | sending | completed | failed | cancelled |
limitquery | integer | no | Page size (1–200, default 100); 400 if it isn't an integerval 1–200, default 100 |
cursorquery | string | no | next_cursor from the previous response (opaque; older date-time cursors are also accepted) |
Example request
curl -X GET "https://hiboty.com/api/v1/campaigns?limit=50" \
-H "Authorization: Bearer $HIBOTY_API_KEY"Example response (200)
{
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Hiboty",
"status": "string",
"body": "string",
"template_name": "string",
"topic": "string",
"audience_count": 1,
"sent_count": 1,
"failed_count": 1,
"scheduled_at": "2026-11-06T09:00:00.000Z",
"started_at": "2026-11-06T09:00:00.000Z",
"completed_at": "2026-11-06T09:00:00.000Z",
"created_at": "2026-11-06T09:00:00.000Z",
"best_time": true,
"paused_at": "2026-11-06T09:00:00.000Z",
"pause_reason": "hata_orani"
}
],
"next_cursor": "string"
}Possible errors
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).401The API key is missing, invalid or revoked (unauthorized).403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.