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 campaign participants

Lists the campaign's participants with their balances, flags and submission counts.

GET
/v1/creator-campaigns/{campaignId}/participants

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

campaignId*string

Campaign ID.

Query Parameters

status?string

Value in

  • "invited"
  • "active"
  • "suspended"
  • "removed"
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.listCampaignParticipants({  path: {    campaignId: 'campaign_abc123',  },});console.log(data);
{  "participants": [    {      "id": "string",      "campaignId": "string",      "creator": {        "id": "string",        "displayName": "string",        "email": "string"      },      "status": "invited",      "joinedAt": "2019-08-24T14:15:22Z",      "accounts": [        {          "accountId": "string",          "verifiedAt": "2019-08-24T14:15:22Z",          "platform": "string",          "username": "string"        }      ],      "balances": {        "accruing": 0,        "owed": 0,        "payable": 0,        "settling": 0,        "settled": 0      },      "flags": [        {          "code": "linked_accounts",          "detail": "string",          "raisedAt": "2019-08-24T14:15:22Z"        }      ],      "submissionCounts": {        "received": 0,        "tracking": 0,        "pending_review": 0,        "approved": 0,        "rejected": 0,        "expired": 0,        "withdrawn": 0      },      "payout": {        "status": "not_started"      }    }  ],  "total": 0}
Was this page helpful?

List campaign ledger

Lists ledger entries, newest first. Without `participantId` it lists every entry of the campaign: earnings drawn from the budget (accruals, per-post payments, pool shares, adjustments), the approvals, hold releases and settlements that move money between its participants' buckets, and their reversals. Pass `participantId` to narrow the list to one participant's entries.

List campaign payables

Lists every participant with a payable balance (earnings past their hold), with the ledger entries behind it. Pay these, then record each payout with the settle endpoint.