Read a creator invite or participant page
What a creator sees behind a campaign link, with no API key. token is either an open
invite token (from POST /v1/creator-campaigns/{campaignId}/invite-link), which answers
kind: invite with the campaign only, or a participant token (from an invite or a join),
which answers kind: participant with the creator's connected accounts, latest 100
submissions, earnings and payout setup. Reading a participant page also re-checks the
creator's connected accounts. Never cached.
Path Parameters
A participant token or an open invite token. A malformed token answers 404 like an unknown one.
^[A-Za-z0-9_-]{16,128}$Response Body
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.creatorportal.getCreatorPortal();console.log(data);{ "kind": "invite", "campaign": { "id": "string", "name": "string", "brandName": "string", "logoUrl": "string", "theme": {}, "status": "draft", "platforms": [ "string" ], "contentRules": "string", "startsAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z", "currency": "string", "economics": { "type": "cpm", "ratePer1kCents": 0, "minViewsToEarn": 0, "maxPayoutPerClipCents": 0 }, "maxPostAgeMinutes": 0, "holdDays": 0, "trackingDays": 0 }}List a creator's earnings history
The participant's ledger entries, newest first, with the bucket each one moved money from and to (`accruing`, `owed`, `payable`, `settling`, `settled`; null for the other side), plus the payout setup. Never cached.
Join a campaign
Accepts a participant invite, or joins through an open invite link. With a participant token the body is ignored and the invite is accepted. With an open invite token a new participant is created from `displayName` (required) and `email` (optional), and a fresh participant token comes back: keep it, it is the creator's only key to their page. Open-link joins are limited to about 20 per IP address and 60 per link every 10 minutes.