Skip to main content
GET
/
campaigns
List campaigns
curl --request GET \
  --url https://api.getarbol.com/v1/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "requestId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use your API key from the Arbol dashboard. Go to Settings > API Keys to generate one.

Query Parameters

​
limit
integer
default:50

Max items to return (1-100)

Required range: 1 <= x <= 100
​
offset
integer
default:0

Items to skip

Required range: x >= 0
​
agentId
string
​
status
enum<string>
Available options:
DRAFT,
SCHEDULED,
QUEUED,
RUNNING,
PAUSED,
COMPLETED,
CANCELLED,
FAILED
​
search
string

Response

List of campaigns