Skip to main content

GET /sdk/v2/campaigns/:campaignId/creators

Returns the creators in one campaign. Use fields to request only the data your application needs. Every response includes campaignId, campaignCreatorRecordId, and creatorProfileId so you can use the creator in the other campaign endpoints.
Use this v2 endpoint for new integrations. The v1 creator list remains available with its original response for existing clients.
All requests require X-Application-Id and X-Api-Key.

Path parameter

  • campaignId (required): the campaign to list.

Query parameters

  • page (optional): page number, starting at 1. Default: 1.
  • limit (optional): creators per page. Default: 100; maximum: 500.
  • fields (optional): comma-separated response fields.
  • startDate and endDate (optional): an inclusive YYYY-MM-DD range. Send both or neither. The maximum range is 366 days.
  • search or query (optional): searches creator names and email addresses.
  • includeHidden (optional): set to true to include hidden campaign creators.
  • sortBy (optional): creatorName, totalViews, totalLikes, totalComments, or totalShares.
  • sortOrder (optional): asc or desc.
When you use a date range, performance totals and pendingValue are calculated for that range. Current contract fields still describe the contract active today. Date-scoped results can only be sorted by creatorName.

Available fields

  • Identity: campaignId, campaignCreatorRecordId, creatorProfileId, creatorName, creatorEmail, isVerified, hidden
  • Payment: pendingValue, currency, payoutType, fixedRate, performanceRate
  • Performance: totalPosts, totalViews, totalLikes, totalComments, totalShares, lastCalculatedAt
  • Contract: currentContract, nextScheduledContract
If you omit fields, the response includes identity, pending payment, performance, current contract, and next scheduled contract data.

Example request

Response

effectiveTimeZone is the IANA timezone Grade uses for the campaign after applying the campaign override, agency fallback, and final UTC fallback. Use it when interpreting business dates in campaign payment and contract data.

Common errors

  • 400: unsupported field, invalid pagination, or invalid date range
  • 401: missing or invalid SDK credentials
  • 404: campaign not found
Use the returned campaignCreatorRecordId to preview a payout, read line items, or read contract history.