Skip to main content
GET
List initiatives

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Query Parameters

limit
integer
default:100

Page size.

Required range: 1 <= x <= 1000
cursor
string

Opaque token from a prior response’s next_cursor.

status
string

Comma-separated lifecycle filter, e.g. DRAFT,ACTIVE. Allowed: DRAFT, ACTIVE, PAUSED, COMPLETED, CANCELED.

isRecurring
boolean

Narrow to one kind: false returns campaigns (one-time outreach), true returns initiatives (ongoing work). Passing this without isTransactional excludes Transactionals. Omit both this and isTransactional to return every kind, which is the default.

isTransactional
boolean

true returns only Transactionals (one event sends a message). Omit both this and isRecurring to return every kind, which is the default; isRecurring alone excludes Transactionals; false excludes them.

Response

Success

data
object[]
required
next_cursor
string | null
required