Skip to main content
GET
Get Many Campaigns
This endpoint uses the Campaign object.
Don’t forget to set the query parameter version to version=v2.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

offset
integer

Offset from the start. For pagination.

limit
integer

Number of campaigns to retrieve. Default: 100. Maximum: 100.

version
enum<string>
default:v2

Set to 'v2' to use the latest version

Available options:
v2
page
integer

Page number to retrieve

sortBy
enum<string>

The field by which to sort. Currently, only 'createdAt' is supported.

Available options:
createdAt
sortOrder
enum<string>

The sort direction. Use 'desc' for descending order; any other value (or omission) will sort in ascending order.

Available options:
asc,
desc
status
enum<string>

The campaign status. Can be: running, draft, archived, ended, paused, errors. Note: a campaign can be in multiple statuses at one time (e.g., a paused campaign with errors).

Available options:
running,
draft,
archived,
ended,
paused,
errors
createdBy
string

Filter campaigns by creator user ID (usr_xxx format). Only returns campaigns created by the specified user.

Response

Success

_id
string

Unique campaign identifier

name
string

Campaign name

labels
string[]

Categorization labels

createdAt
string<date-time>

Creation timestamp

createdBy
string

Creator user ID

status
enum<string>

Campaign status

Available options:
running,
paused,
draft,
ended,
archived,
errors
sequenceId
string

Main sequence ID

scheduleIds
string[]

Associated schedule IDs

teamId
string

ID of the team that owns this campaign

hasError
boolean

Whether the campaign has errors

errors
string[]

List of error messages if campaign has errors

creator
object

Campaign creator information

senders
object[]

Campaign senders configuration