All documentation
Documentation
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.
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 at1. Default:1.limit(optional): creators per page. Default:100; maximum:500.fields(optional): comma-separated response fields.startDateandendDate(optional): an inclusiveYYYY-MM-DDrange. Send both or neither. The maximum range is 366 days.searchorquery(optional): searches creator names and email addresses.includeHidden(optional): set totrueto include hidden campaign creators.sortBy(optional):creatorName,totalViews,totalLikes,totalComments, ortotalShares.sortOrder(optional):ascordesc.
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
curl -sS "$BASE_URL/sdk/v2/campaigns/camp_123/creators?page=1&limit=100&fields=creatorName,creatorEmail,pendingValue,currency,totalViews,currentContract&startDate=2026-07-01&endDate=2026-07-31" \
-H "X-Application-Id: $APP_ID" \
-H "X-Api-Key: $API_KEY"
Response
{
"success": true,
"data": [
{
"campaignId": "camp_123",
"campaignCreatorRecordId": "CCR_123",
"creatorProfileId": "CP_123",
"creatorName": "Jordan Lee",
"creatorEmail": "jordan@example.com",
"pendingValue": 550,
"currency": "USD",
"totalViews": 50000,
"currentContract": {
"effectiveDate": "2026-07-01",
"contract": {
"type": "HYBRID",
"currency": "USD",
"fixedPayment": {
"currency": "USD",
"conversionPolicy": null,
"amount": 300,
"per": "CREATOR",
"calculation": "STANDARD",
"upfrontPercentage": null,
"expectedPosts": null,
"minimumPosts": null,
"prorateByTime": false,
"platforms": [],
"crossposts": null
},
"cpmPayment": {
"currency": "USD",
"conversionPolicy": null,
"rate": 5,
"perViews": 1000,
"viewsFrom": "POST",
"minimumViews": 0,
"maximumViews": null,
"excludeMinimumViews": false,
"maximumSpend": null,
"crossposts": "EACH_POST",
"pays": "NOW"
},
"bonusPayment": null,
"crosspostRequirements": null,
"recurringPayment": null,
"postsUploadedOnOrAfter": null
}
}
}
],
"pagination": {
"page": 1,
"limit": 100,
"total": 1,
"totalPages": 1
},
"dateRange": {
"startDate": "2026-07-01",
"endDate": "2026-07-31"
},
"effectiveTimeZone": "America/New_York"
}
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 range401: missing or invalid SDK credentials404: campaign not found
Use the returned campaignCreatorRecordId to preview a payout,
read line items, or
read contract history.
