Skip to main content
GET
List a campaign's queue

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Path Parameters

campaignId
string
required

The campaign's id.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$

Query Parameters

status
enum<string>
required

The messages to list: approval_required (written by AI, waiting for your approval), scheduled (going out at scheduledAt), sent, skipped, stopped (declined) or overwritten (replaced by an edit).

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

Only the messages of this channel.

Available options:
email,
linkedin_connection,
linkedin_message,
linkedin_visit,
linkedin_like,
inmail
pageSize
integer
default:25

Items per page.

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

The pagination.nextCursor of the page before. Later pages keep the first page's size.

Required string length: 1 - 200

Response

One page of the campaign's messages in one state.

data
object[]
required
pagination
object
required