Archive API docs
    Jump to

    Narrow by kind with a prefix — q: queries, m: mutations, t: types, g: guides, f: fields and arguments.

    Jump to examples ↓
    Query

    campaignCreators

    Paginate one campaign's roster, newest first, with each creator's campaign-specific custom attributes. An unknown campaign ID, or one from another workspace, returns a NOT_FOUND error. Paging is offset-based: rows added or removed between pages can be skipped or returned twice.

    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.
    campaignId ID! required
    ID of the campaign whose roster to page through (as returned by campaigns).
    customAttributeConditions [CustomAttributeConditionInput!] default []
    Conditions on the campaign creator custom attributes, combined with AND. Read the keys with customAttributeSchemas(entity: CAMPAIGN_CREATOR). Three creator-level fields are also accepted: labels, creator_name and posting_activity (IS or IS_NOT, value "posted" or "not_posted"). Each of these three takes one condition at most. post_date and collections are refused with UNSUPPORTED_CUSTOM_ATTRIBUTE_CONDITION.
    first Int default 20
    Number of campaign creators to return (page size).
    sorting [CampaignCreatorSortingInput!] default [{sortKey: ADDED_AT, sortOrder: DESC}]
    Sorting instructions to apply to the roster. Ties break on the roster entry ID.

    Returns

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

    edges [CampaignCreatorEdge!]!
    List of edges with cursors.
    nodes [CampaignCreator!]!
    List of campaign creators.
    pageInfo PageInfo!
    Pagination information.
    totalCount Int
    Total number of items available.