Documentation / SDK v1

Creators

Creator-specific receipts, totals, and payouts via /sdk/v1.

creators · json
{
  "success": true,
  "data": [
    {
      "invoiceId": "inv_...",
      "status": "PAID",
      "payoutDate": "2026-02-19T00:00:00.000Z",
      "earningsValue": 150,
      "campaignName": "Spring campaign",
      "currency": "USD"
    }
  ],
  "pagination": { "page": 1, "limit": 50, "totalPages": 1, "totalItems": 1 }
}
All documentation

All endpoints below require:

  • X-Application-Id
  • X-Api-Key

All creator endpoints require an email query parameter. The creator must exist and be associated with the authenticated agency.

GET /sdk/v1/creators/receipts

List receipts for a creator.

Query parameters

  • email (required)
  • page (default 1)
  • limit (default 50, max 100)
  • search or query (optional; searches campaign name)
  • sortBy (optional): campaignName, payoutDate, earningsValue, status
  • sortOrder (optional): asc or desc

Response

{
  "success": true,
  "data": [
    {
      "invoiceId": "inv_...",
      "status": "PAID",
      "payoutDate": "2026-02-19T00:00:00.000Z",
      "earningsValue": 150,
      "campaignName": "Spring campaign",
      "currency": "USD"
    }
  ],
  "pagination": { "page": 1, "limit": 50, "totalPages": 1, "totalItems": 1 }
}

Common errors

  • 400: missing/invalid email
  • 404: creator not found for this agency

GET /sdk/v1/creators/total-paid

Get total paid to a creator, returning both USD and the agency preferred currency totals.

Query parameters

  • email (required)

Response

{
  "success": true,
  "data": {
    "email": "creator@example.com",
    "spentAmountUSD": 100,
    "spentAmountPreferred": 141.32,
    "preferredCurrency": "CAD"
  }
}

GET /sdk/v1/creators/payouts

List payouts for a creator.

Query parameters

Same as GET /sdk/v1/payouts, plus:

  • email (required)

Response

{
  "success": true,
  "data": [{ "payoutId": "pay_...", "status": "claimed", "currency": "USD" }],
  "pagination": { "page": 1, "limit": 50, "totalPages": 1, "totalItems": 1 },
  "meta": { "bufferBusinessDays": 1, "accelerated": false, "bankClosedDates": [] }
}

Agency creator directory

GET /sdk/v1/creators requires payouts:read, because directory results can contain financial summaries. Query parameters include search (or query), page, limit, sortBy, sortOrder, and min for the platform's compact representation. Results are restricted to creators connected to the API key's agency.

GET /sdk/v1/creators/:creatorProfileId returns the agency-scoped creator profile and also requires payouts:read. The profile ID comes from directory or campaign-creator results. A profile outside the agency is not accessible.

Describe your program.

Grade turns it into a program it can track and pay.