Zernio
APIFor you
Zernio
APIFor you
API Reference

Creator Campaigns

List campaign ledgerGETList campaign participantsGETList campaign payablesGETList payout batchesGETList campaign submissionsGETList creator campaignsGETCreate campaign adjustmentPOSTCreate campaign invite linkPOSTInvite campaign participantPOSTPay creators with one card paymentPOSTCreate creator campaignPOSTGet campaign participantGETGet campaign reportGETGet campaign submissionGETGet creator campaignGETUpdate creator campaignPATCHActivate creator campaignPOSTApprove campaign submissionPOSTClose creator campaignPOSTPause creator campaignPOSTRaise creator campaign budgetPOSTReinstate campaign participantPOSTReject campaign submissionPOSTRemove campaign participantPOSTReopen campaign submissionPOSTSettle campaign participantPOSTSuspend campaign participantPOST
Dashboard
OverviewPlatformsAPI ReferenceResources
Creator Campaigns

List creator campaigns

Lists the team's campaigns in the profiles this key can reach, newest first.

GET
/v1/creator-campaigns

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Query Parameters

status?string

Value in

  • "draft"
  • "active"
  • "paused"
  • "closed"
profileId?string

Only campaigns in this profile.

q?string

Only campaigns whose name or brand name contains this text, ignoring case.

Length1 <= length <= 100
limit?integer
Range1 <= value <= 200
Default50
skip?integer
Range0 <= value
Default0

Response Body

application/json

application/json

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.creatorcampaigns.listCreatorCampaigns();console.log(data);
{  "campaigns": [    {      "id": "string",      "userId": "string",      "profileId": "string",      "kind": "string",      "name": "string",      "brandName": "string",      "status": "draft",      "type": "cpm",      "currency": "string",      "platforms": [        "tiktok"      ],      "contentRules": "string",      "startsAt": "2019-08-24T14:15:22Z",      "endsAt": "2019-08-24T14:15:22Z",      "trackingDays": 0,      "holdDays": 0,      "maxPostAgeMinutes": 0,      "settlement": "none",      "economics": {        "type": "cpm",        "ratePer1kCents": 1,        "minViewsToEarn": 0,        "maxPayoutPerClipCents": 1,        "budgetCents": 0      },      "caps": {        "maxParticipants": 1,        "maxSubmissionsPerParticipantPerDay": 1,        "maxAccountsPerParticipant": 1,        "authenticityThreshold": 0      },      "branding": {        "brandName": "string",        "primaryColor": "string",        "logoUrl": "string",        "theme": {}      },      "budgetExhaustedAt": "2019-08-24T14:15:22Z",      "closedAt": "2019-08-24T14:15:22Z",      "payableScannedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "hasOpenInvite": true,      "consumedCents": 0,      "participantCount": 0,      "submissionCounts": {        "received": 0,        "tracking": 0,        "pending_review": 0,        "approved": 0,        "rejected": 0,        "expired": 0,        "withdrawn": 0      }    }  ],  "total": 0}
Was this page helpful?

List campaign submissions

Lists submitted posts with views, earnings, authenticity score and flags. Filter by status, participant, flag, platform or score range to build a review queue, for example `status=pending_review`.

Create campaign adjustment

Posts a manual adjustment to a participant's payable balance against the campaign budget: a positive amount credits the participant (a bonus), a negative one claws back. `cause` is kept on the ledger entry. A claw-back larger than the payable balance answers 409.