Skip to main content
GET
List campaigns
Use this endpoint when your integration needs to discover or verify a sequence before assignment.

Authorizations

x-api-key
string
header
required

Primary public authentication method. Create keys in Jobin.cloud under Workgroups > Integrations > Custom integration.

Query Parameters

page
integer
default:1

One-based result page. Page-number pagination is capped at 100.

Required range: 1 <= x <= 100
limit
integer
default:25
Required range: 1 <= x <= 25
isActive
boolean
includeArchived
boolean
default:false
includeTotal
boolean
default:false

When true, include the matching campaign count. The default is false to avoid unnecessary count work.

Response

Paged campaigns

items
object[]
page
integer
limit
integer
total
integer | null

Total matching campaigns when includeTotal=true; otherwise null.