Skip to main content
List Campaigns
curl --request GET \
  --url https://api.agents.timepay.ai/api/v1/campaigns \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "data": [
    {
      "id": "QSoSyUUwwhwEiFhXJIUlhYxOh",
      "tableId": "campaign_jyyrsvgpynmxetfiuiba_kiwwhjupmwyjabnrlillydlsw",
      "rowsLen": 1,
      "createdAt": "2026-01-05T14:44:15",
      "updatedAt": "2026-01-05T14:44:51",
      "org_id": "JYYrSvGpyNMxetfiuiBa",
      "name": "Campaign 1",
      "description": "Q1 debt collection campaign for overdue accounts",
      "startDate": "2025-12-31",
      "startTime": "09:00",
      "endDate": "2025-12-31",
      "endTime": "19:00",
      "collection_type": "emi",
      "region": "north",
      "tags": [
        "priority",
        "q1"
      ],
      "languages": [
        "hindi",
        "english"
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 50,
    "totalPages": 5
  }
}

​
Headers

​
Authorization
string
required
Bearer token for authentication (e.g., Bearer <your_token>).

​
Query Parameters

​
page
integer
default:1
The page number for pagination.
​
limit
integer
default:10
The number of items to return per page.
​
status
string
Filter campaigns by status.
​
campaign_type
string
Filter by the type of campaign.
​
search
string
Search term to filter campaigns by name.

​
Response

​
success
boolean
Indicates if the request was successful.
​
data
array
The list of campaign objects.
​
pagination
object
Pagination details.
​
error
string
The error type or code (Error responses only).
​
message
string
A descriptive message explaining the error (Error responses only).
{
  "success": true,
  "data": [
    {
      "id": "QSoSyUUwwhwEiFhXJIUlhYxOh",
      "tableId": "campaign_jyyrsvgpynmxetfiuiba_kiwwhjupmwyjabnrlillydlsw",
      "rowsLen": 1,
      "createdAt": "2026-01-05T14:44:15",
      "updatedAt": "2026-01-05T14:44:51",
      "org_id": "JYYrSvGpyNMxetfiuiBa",
      "name": "Campaign 1",
      "description": "Q1 debt collection campaign for overdue accounts",
      "startDate": "2025-12-31",
      "startTime": "09:00",
      "endDate": "2025-12-31",
      "endTime": "19:00",
      "collection_type": "emi",
      "region": "north",
      "tags": [
        "priority",
        "q1"
      ],
      "languages": [
        "hindi",
        "english"
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 50,
    "totalPages": 5
  }
}