Skip to main content
GET
/
api
/
v1
/
campaigns
Get paginated list of campaigns
curl --request GET \
  --url https://{subdomain}.mihu.ai/api/v1/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Campaigns retrieved successfully",
  "data": {
    "current_page": 1,
    "data": [
      {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "status": "Active",
        "campaign_type": "<string>",
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "agent_id": 123,
        "agent_app_id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "first_page_url": "<string>",
    "last_page": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Query Parameters

​
page
integer
default:1

Page number

​
per_page
integer
default:15

Number of items per page

​
search
string

Search term for campaign name or description

​
status
enum<string>

Filter by campaign status

Available options:
Active,
Draft,
Completed,
Archived

Response

Success

​
success
boolean
Example:

true

​
message
string
Example:

"Campaigns retrieved successfully"

​
data
object