Skip to main content
Get Campaign
curl --request GET \
  --url https://api.agents.timepay.ai/api/v1/campaigns/{id} \
  --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",
		"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"
		]
	}
}

Headers

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

Path Parameters

id
string
required
The unique identifier of the campaign (e.g., camp_abc123).

Response

success
boolean
Indicates if the request was successful.
data
object
The campaign object containing full 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",
		"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"
		]
	}
}