Query

campaigns

List and paginate campaigns for the current workspace, ordered newest first. Excludes campaigns of templates hidden for the workspace. Workflow campaigns appear only when their type is exposed by the API and the in-app campaigns page lists them.

Paginated · weighted cost MCP: getCampaigns

Arguments

Object, input and enum types open in place — use + to reveal their fields. A type that is already open above the row stops at a ↻ circular marker, and anything nested past the depth limit links out to its own page instead.

after String default null: Cursor for fetching the next page of results.
filter CampaignFilterInput default {}: Filter criteria to narrow down results (by campaign type, externalId or name).
campaignTypes [CampaignType!] default []: Only campaigns of these types. A campaign with a null campaignType never matches.
BRAND_MONITORING: Brand Monitoring: Archive captures native content (Instagram Reels, TikTok, YouTube) between dateStart (required) and dateEnd (optional; omitted means open-ended). One created through the API captures workspace-wide (the app's default "any creator" mode), so its roster does not narrow what is captured. One built in the app may instead be scoped to its roster, in which case adding creators decides what is captured. updateCampaign changes its name, end date, roster and posts; its tag, content and source narrowing are kept as stored. updateCampaign(posts:) adds specific posts on top of automatic capture, and capture never removes posts. Adding a post puts its creator on the roster, which can capture more of that creator's in-window posts from brand-listening sources. A post taken out with posts.remove can be captured again by a later replay (a creator added, a date edit) when it is in-window and from a brand-listening source. Read the posts with items(filter: { campaignsIds: [<campaign id>] }). An open-ended campaign cannot be given a dateEnd through updateCampaign. No options: send no settings.
CONTENT_CAPTURE: Content Capture: one created through the API has no capture triggers, so Archive adds no posts on its own and it holds exactly the posts you add with updateCampaign(posts:). One built in the app keeps the capture triggers the app gave it, so Archive can still add posts to it; it is updatable the same way. Read the posts with items(filter: { campaignsIds: [<campaign id>] }); that list is search-indexed and catches up shortly after a change, so diff against it on a later run, not right after patching. dateStart and dateEnd are optional. No options: send no settings.
CREATOR_MONITORING: Creator Monitoring: Archive captures the posts every creator on the roster publishes between dateStart and dateEnd (both required). Options: settings.creatorMonitoring.
VETTING_WORKFLOW: Vetting Workflow: AI brand safety review of the posts each rostered creator published. The window is dateStart to dateEnd, both required. dateEnd may not be more than 24 hours from now. A creator's posts are pulled once, when they are added. Roster: INSTAGRAM and TIKTOK profiles. Options: settings.vettingWorkflow. Available only in a workspace whose Archive app lists Vetting Workflow campaigns; elsewhere they are neither listed nor created.
externalIds [String!] default []: Only campaigns created through createCampaign with one of these externalId keys. Matching is exact.
nameContains String: Only campaigns whose name contains this text, ignoring case, as the Archive app matches names. "%" and "_" match themselves.
first Int default 20: Number of campaigns to return (page size).

Returns

A paginated connection of Campaign nodes. See Pagination for the connection shape.

edges [CampaignEdge!]!: List of edges with cursors.
cursor String!: Cursor for this node.
node Campaign!: The campaign.
campaignType CampaignType: What kind of campaign this is; null for a campaign whose type the API does not expose.
BRAND_MONITORING: Brand Monitoring: Archive captures native content (Instagram Reels, TikTok, YouTube) between dateStart (required) and dateEnd (optional; omitted means open-ended). One created through the API captures workspace-wide (the app's default "any creator" mode), so its roster does not narrow what is captured. One built in the app may instead be scoped to its roster, in which case adding creators decides what is captured. updateCampaign changes its name, end date, roster and posts; its tag, content and source narrowing are kept as stored. updateCampaign(posts:) adds specific posts on top of automatic capture, and capture never removes posts. Adding a post puts its creator on the roster, which can capture more of that creator's in-window posts from brand-listening sources. A post taken out with posts.remove can be captured again by a later replay (a creator added, a date edit) when it is in-window and from a brand-listening source. Read the posts with items(filter: { campaignsIds: [<campaign id>] }). An open-ended campaign cannot be given a dateEnd through updateCampaign. No options: send no settings.
CONTENT_CAPTURE: Content Capture: one created through the API has no capture triggers, so Archive adds no posts on its own and it holds exactly the posts you add with updateCampaign(posts:). One built in the app keeps the capture triggers the app gave it, so Archive can still add posts to it; it is updatable the same way. Read the posts with items(filter: { campaignsIds: [<campaign id>] }); that list is search-indexed and catches up shortly after a change, so diff against it on a later run, not right after patching. dateStart and dateEnd are optional. No options: send no settings.
CREATOR_MONITORING: Creator Monitoring: Archive captures the posts every creator on the roster publishes between dateStart and dateEnd (both required). Options: settings.creatorMonitoring.
VETTING_WORKFLOW: Vetting Workflow: AI brand safety review of the posts each rostered creator published. The window is dateStart to dateEnd, both required. dateEnd may not be more than 24 hours from now. A creator's posts are pulled once, when they are added. Roster: INSTAGRAM and TIKTOK profiles. Options: settings.vettingWorkflow. Available only in a workspace whose Archive app lists Vetting Workflow campaigns; elsewhere they are neither listed nor created.
createdAt DateTime!: When the campaign was created (UTC).
creatorsCount Int!: Creators currently on the roster. Creators added by handle through updateCampaign join it once their background import resolves them; creators added by id join it during the call.
dateEnd DateTime: End of the campaign's window (UTC); null when it has none.
dateStart DateTime: Start of the campaign's window (UTC); null when it has none.
excludeCreatorsInOtherVettingCampaigns Boolean: Whether a VETTING_WORKFLOW campaign skips creators already on another one of the workspace. Null for a campaign of another type, or one created before the option existed.
externalId String: The key the campaign was created with through createCampaign; null for a campaign created in the Archive app.
id ID!: Unique identifier for the campaign in Archive's system.
maxMediaItemsPerCreator Int: Most posts per creator a VETTING_WORKFLOW campaign pulls and reviews (1000000 means no limit). Null for a campaign of another type.
name String!: Campaign name as shown in Archive.
pullLogic CampaignPullLogic: Whether a CREATOR_MONITORING campaign captures posts carrying any or all of its tagNames. Null for a campaign of another type.
HAS_ALL: Capture a post only when it carries every one of the tag names.
HAS_ANY: Capture a post that carries any of the tag names.
tagNames [String!]: Hashtags and mentions a CREATOR_MONITORING campaign narrows capture to, as stored (lowercased, deduplicated); empty captures every post the roster publishes in the window. Null for a campaign of another type.
nodes [Campaign!]!: List of campaigns.
campaignType CampaignType: What kind of campaign this is; null for a campaign whose type the API does not expose.
BRAND_MONITORING: Brand Monitoring: Archive captures native content (Instagram Reels, TikTok, YouTube) between dateStart (required) and dateEnd (optional; omitted means open-ended). One created through the API captures workspace-wide (the app's default "any creator" mode), so its roster does not narrow what is captured. One built in the app may instead be scoped to its roster, in which case adding creators decides what is captured. updateCampaign changes its name, end date, roster and posts; its tag, content and source narrowing are kept as stored. updateCampaign(posts:) adds specific posts on top of automatic capture, and capture never removes posts. Adding a post puts its creator on the roster, which can capture more of that creator's in-window posts from brand-listening sources. A post taken out with posts.remove can be captured again by a later replay (a creator added, a date edit) when it is in-window and from a brand-listening source. Read the posts with items(filter: { campaignsIds: [<campaign id>] }). An open-ended campaign cannot be given a dateEnd through updateCampaign. No options: send no settings.
CONTENT_CAPTURE: Content Capture: one created through the API has no capture triggers, so Archive adds no posts on its own and it holds exactly the posts you add with updateCampaign(posts:). One built in the app keeps the capture triggers the app gave it, so Archive can still add posts to it; it is updatable the same way. Read the posts with items(filter: { campaignsIds: [<campaign id>] }); that list is search-indexed and catches up shortly after a change, so diff against it on a later run, not right after patching. dateStart and dateEnd are optional. No options: send no settings.
CREATOR_MONITORING: Creator Monitoring: Archive captures the posts every creator on the roster publishes between dateStart and dateEnd (both required). Options: settings.creatorMonitoring.
VETTING_WORKFLOW: Vetting Workflow: AI brand safety review of the posts each rostered creator published. The window is dateStart to dateEnd, both required. dateEnd may not be more than 24 hours from now. A creator's posts are pulled once, when they are added. Roster: INSTAGRAM and TIKTOK profiles. Options: settings.vettingWorkflow. Available only in a workspace whose Archive app lists Vetting Workflow campaigns; elsewhere they are neither listed nor created.
createdAt DateTime!: When the campaign was created (UTC).
creatorsCount Int!: Creators currently on the roster. Creators added by handle through updateCampaign join it once their background import resolves them; creators added by id join it during the call.
dateEnd DateTime: End of the campaign's window (UTC); null when it has none.
dateStart DateTime: Start of the campaign's window (UTC); null when it has none.
excludeCreatorsInOtherVettingCampaigns Boolean: Whether a VETTING_WORKFLOW campaign skips creators already on another one of the workspace. Null for a campaign of another type, or one created before the option existed.
externalId String: The key the campaign was created with through createCampaign; null for a campaign created in the Archive app.
id ID!: Unique identifier for the campaign in Archive's system.
maxMediaItemsPerCreator Int: Most posts per creator a VETTING_WORKFLOW campaign pulls and reviews (1000000 means no limit). Null for a campaign of another type.
name String!: Campaign name as shown in Archive.
pullLogic CampaignPullLogic: Whether a CREATOR_MONITORING campaign captures posts carrying any or all of its tagNames. Null for a campaign of another type.
HAS_ALL: Capture a post only when it carries every one of the tag names.
HAS_ANY: Capture a post that carries any of the tag names.
tagNames [String!]: Hashtags and mentions a CREATOR_MONITORING campaign narrows capture to, as stored (lowercased, deduplicated); empty captures every post the roster publishes in the window. Null for a campaign of another type.
pageInfo PageInfo!: Pagination information.
endCursor String: Cursor for the last node in this page.
hasNextPage Boolean!: Whether there are more results after this page.
hasPreviousPage Boolean!: Whether there are results before this page.
startCursor String: Cursor for the first node in this page.
totalCount Int: Total number of items available.

query CampaignsDefault($first: Int, $after: String) { campaigns(first: $first, after: $after) { totalCount edges { node { id name createdAt } } pageInfo { hasNextPage endCursor } } }

{ "data": { "campaigns": { "totalCount": 3, "edges": [ { "node": { "id": "115d4e8e-2e30-5d2b-acb8-78cf3d81eab1", "name": "Fall Refresh", "createdAt": "2024-12-31T00:00:00Z" } }, { "node": { "id": "5ff72fbc-0217-540f-bf25-a83d049772b8", "name": "Summer Gifting", "createdAt": "2024-12-30T00:00:00Z" } }, { "node": { "id": "422fac58-557c-5cd4-8986-84ac3db4b133", "name": "Spring Launch", "createdAt": "2024-12-29T00:00:00Z" } } ], "pageInfo": { "hasNextPage": false, "endCursor": "Z2lkOi8vYXJjaGl2ZS9DYW1wYWlnbi8yMDI0LTEyLTI5VDAwOjAwOjAwLjAwMDAwMFp8NDIyZmFjNTgtNTU3Yy01Y2Q0LTg5ODYtODRhYzNkYjRiMTMz" } } } }