Skip to main content
GET
/
api
/
campaign
List Campaigns
curl --request GET \
  --url https://api.getello.ai/api/campaign \
  --header 'X-API-Key: <api-key>'
{
  "status": 200,
  "message": "Campaigns retrieved successfully",
  "data": {
    "campaigns": [
      {
        "campaign_id": "6901c1d8b004a5d55a123abc",
        "campaignName": "Follow-up Campaign October",
        "status": "scheduled"
      }
    ],
    "total": 0,
    "page": 1,
    "limit": 10,
    "pages": 0
  },
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "totalPages": 0,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
search
string

Search keyword to filter campaigns by name or other attributes.

​
status
enum<string>

Filter campaigns based on their current status.

Available options:
scheduled,
running,
completed,
failed
Example:

"scheduled"

​
page
integer
default:1

The page number to retrieve.

Required range: x >= 1
​
limit
integer
default:10

Number of campaigns to return per page.

Required range: 1 <= x <= 100

Response

Campaigns retrieved successfully

​
status
integer
Example:

200

​
message
string
Example:

"Campaigns retrieved successfully"

​
data
object
​
pagination
object