Skip to main content
GET
The campaign's send queue by status

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Path Parameters

campaignId
string
required

The campaign's id (24-character hex ObjectId), as returned by POST /business/campaigns or as the campaignId of a GET /business/campaigns row.

Query Parameters

status
enum<string>
required

Queue bucket to list: approval_required (AI-drafted sends waiting for your approval), scheduled (queued, goes out at scheduledAt), sent (delivered by Fuse or marked done), skipped (passed over, the contact moved on), stopped (declined, terminal for that contact) or overwritten (replaced by a newer row through PATCH /business/scheduled-sends/{sendId}).

Available options:
approval_required,
scheduled,
sent,
skipped,
stopped,
overwritten
channel
enum<string>

Restrict rows to one channel, named exactly as the queue stores it (the same values a step's channel uses): email, linkedin_connection, linkedin_message, linkedin_visit, linkedin_like, inmail, dialer or todo. Omit to include every channel.

Available options:
email,
linkedin_connection,
linkedin_message,
linkedin_visit,
linkedin_like,
inmail,
dialer,
todo
limit
integer
default:25

Page size, 1-100 (default 25).

Required range: 1 <= x <= 100
pageNum
integer
default:1

1-based page number (default 1).

Required range: x >= 1

Response

Success

sends
object[]
required
pagination
object
required