USuseboom
Initiatives

List initiatives

Changed on

List the organization's initiatives and campaigns, newest first. All three kinds are the same record type: isRecurring splits campaigns from initiatives, and isTransactional selects Transactionals (event-triggered sends, kept out of the other two lists unless you pass it). Archived rows are excluded.

get/api/v1/initiatives

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Query parameters

limitinteger

Page size.

cursorstring

Opaque token from a prior response’s next_cursor.

statusstring

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

isRecurringboolean

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.

isTransactionalboolean

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

next_cursorstring nullable required

Changes

  • 7c7a773b12ceRevision changes
    • info

      added the new optional query request parameter isRecurring

    • info

      added the new optional query request parameter isTransactional

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status