Skip to main content
POST
Search campaigns

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Body

application/json
offset
integer | null
default:0

Records to skip for pagination. Defaults to 0.

Required range: x >= 0
limit
integer
default:100

Max records per page (1–100). Defaults to 100.

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

Case-insensitive match on the campaign name.

Maximum string length: 200
sequence_type
enum<string>

Only campaigns of this type.

Available options:
candidate,
business_development,
candidate_nurture,
client_nurture
is_archived
boolean
default:false

Archived campaigns only when true. Defaults to false.

created_by
string<uuid>

Only campaigns owned by this team member.

sort_by
enum<string>
default:created_at

Defaults to created_at. enrollments sorts by how many people were ever enrolled, reply_rate by the campaign card reply rate (campaigns with no rate last), to find the biggest or best campaigns.

Available options:
created_at,
updated_at,
name,
enrollments,
reply_rate
sort_order
enum<string>
default:desc

Defaults to desc.

Available options:
asc,
desc
include
enum<string>[]

Pass ["stats"] to add enrollment_counts and engagement (reply, open and click rates) to each campaign.

Available options:
stats

Response

Campaigns found

success
enum<boolean>
required
Available options:
true
data
object[]
required
meta
object
required