List campaigns
const url = 'https://api.poweredbyaura.com/v1/campaigns?status=draft&limit=25';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.poweredbyaura.com/v1/campaigns?status=draft&limit=25' \ --header 'Authorization: Bearer <token>'Returns your campaigns, newest first. Campaigns are built and changed in the dashboard.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”draft: being built. testing: takes actions from test keys only. live: takes actions from live keys
and delivers data. paused: takes actions, which count in results but earn nothing. ended: takes actions
for 8 weeks after it ends, to show whether the habit stuck, and earns nothing.
Items per page, from 1 to 100.
The next_cursor from the previous page.
Responses
Section titled “Responses”A page of campaigns.
object
object
Your internal name for the campaign.
What customers see, such as “Your 6GB plan from [App]”.
draft: being built. testing: takes actions from test keys only. live: takes actions from live keys
and delivers data. paused: takes actions, which count in results but earn nothing. ended: takes actions
for 8 weeks after it ends, to show whether the habit stuck, and earns nothing.
How a customer’s plan starts. action: after the action marked starts_plan, such as a first deposit. offer: by an offer you send with POST /offers, with no action needed first.
Changing a reward starts a new version, so customers in one version are treated the same.
How often the plan’s data arrives, and so how long each period is.
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
How many periods a customer can hold the plan.
object
The name your developers send in action.
The readable name shown in the dashboard.
Whether this action starts a customer’s plan. Always false in a campaign that starts plans by offer.
Whether this action keeps the plan for the period it happens in.
Whether this is the plan’s result, the action the plan exists to grow.
Whether this action is a referral, sent with the friend who did it.
The least the action must carry to count, when the plan sets one. Below it, the action earns nothing.
object
object
Amount in the currency’s minor unit (kobo for NGN).
ISO 4217 currency code.
A one-off reward for the action that starts the plan, when the plan has one.
What the customer and the friend each earn for a referral, when the plan has referrals.
The plan’s bigger size, when a plan that grows is switched on. Off by default.
object
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
The share of new customers placed in the comparison group, from 0 to 0.5. 0 when it is off.
Example
{ "object": "list", "data": [ { "object": "campaign", "status": "draft", "starts_with": "action", "cadence": "daily", "actions": [ { "key": "weekly_deposit", "name": "Weekly deposit" } ] } ]}Headers
Section titled “Headers”Example
req_7Kp2Vx9QmR4tA unique ID for this request. Quote it when you contact Aura.
The request is malformed or a field is invalid. Fix it before retrying.
object
object
A stable, machine-readable code. New codes may be added in v1, so treat an unknown code by its HTTP
status and retryable flag. The first block is shared with the Data Reselling API.
A human-readable explanation. Do not parse it; use code.
The request field the error is about, when there is one.
Whether the same request can succeed if you retry it later.
Extra facts about the error, such as the existing action.
object
Examples
{ "error": { "code": "invalid_phone_number", "message": "phone_number must be in E.164 format, such as +2348000000001.", "param": "phone_number", "retryable": false, "request_id": "req_9Qd4Hs1XvB7n" }}Headers
Section titled “Headers”Example
req_7Kp2Vx9QmR4tA unique ID for this request. Quote it when you contact Aura.
The API key is missing, wrong or revoked.
object
object
A stable, machine-readable code. New codes may be added in v1, so treat an unknown code by its HTTP
status and retryable flag. The first block is shared with the Data Reselling API.
A human-readable explanation. Do not parse it; use code.
The request field the error is about, when there is one.
Whether the same request can succeed if you retry it later.
Extra facts about the error, such as the existing action.
object
Examples
{ "error": { "code": "invalid_api_key", "message": "The API key is missing, wrong or revoked.", "retryable": false, "request_id": "req_4Lm8Tc2VqZ7k" }}Headers
Section titled “Headers”Example
req_7Kp2Vx9QmR4tA unique ID for this request. Quote it when you contact Aura.
Too many requests. Wait for Retry-After seconds, then retry.
object
object
A stable, machine-readable code. New codes may be added in v1, so treat an unknown code by its HTTP
status and retryable flag. The first block is shared with the Data Reselling API.
A human-readable explanation. Do not parse it; use code.
The request field the error is about, when there is one.
Whether the same request can succeed if you retry it later.
Extra facts about the error, such as the existing action.
object
Examples
{ "error": { "code": "rate_limited", "message": "Too many requests. Retry after 2 seconds.", "retryable": true, "request_id": "req_2Vb7Nx4KtJ9q" }}Headers
Section titled “Headers”Example
req_7Kp2Vx9QmR4tA unique ID for this request. Quote it when you contact Aura.
Requests allowed in the current window.
Requests left in the current window.
Seconds until the current window resets.
Seconds to wait before retrying.
© 2026 PressOne Africa Limited ·poweredbyaura.com ·Privacy ·Terms