Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Query Parameters

environment
enum<string>

Filter campaigns by environment

Available options:
production,
test
isLive
boolean

Filter live campaigns only

isDefault
boolean

Filter default campaigns only

orderBy
object

Sorting criteria. Available options: createdAt

orderDirection
object

Sorting direction. Available options: asc, desc

Response

200 - application/json
name
string
required
refereeLandingPageUrl
object | null
required
termsUrl
object | null
required
proposedRewardTrigger
object | null
required
manualRewardTrigger
object | null
required
inviteMessage
object | null
required
isLive
boolean
required
isDefault
boolean
required
environment
enum<string>
required
Available options:
production,
test
copiedFromCampaignId
object | null
required
id
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
deletedAt
object | null
required
organizationId
string
required
applicationId
string
required
lastPingAt
object | null
required
lastPingOrigin
object | null
required
rewards
object[]
required
emails
object[]
required
campaignPages
object[]
required
faqs
object[]
required
platforms
enum<string>[]
required
Available options:
mobile,
web