Skip to main content

Campaign

A FlipGive campaign.

type Campaign {
  accessCode: String!
  activeGroups: [Group!]!
  activePlayerCount: Int
  allFilteredGroups(
  isActive: Boolean
  isDrafted: Boolean
): [Group!]
  amountRaised: DollarFormats!
  amountRaisedBreakdown(
  fundraiserId: ID
  onlyTeamSupports: Boolean = false
): AmountRaisedBreakdown!
  amountWithdrawnBreakdown: AmountWithdrawnBreakdown!
  beneficiary: Beneficiary
  brand: Brand
  budgetApprovals: Boolean!
  category: CampaignCategory!
  city: String
  claimedAt: DateISO
  closeReport: CampaignCloseReport!
  country: Country
  currency: Currency!
  daysOrHoursLeftLabel: String
  deadline: DateISO
  defaultPlayerGoal: DollarFormats
  deletedGroups: [Group!]!
  description: String
  directAmountRaised: DollarFormats!
  division: Organization
  endsOn: DateISO
  externalPartnerRef: String
  externalPartnerType: ExternalPartnerType
  filteredGroups(
  isActive: Boolean
  isDrafted: Boolean
): [Group!]
  fundraisers: [Fundraiser!]! @deprecated
  fundsDistributionMethod: FundsDistributionMethod
  fundsObjective: String
  fundsObjectiveType: String
  goal: DollarFormats
  group(
  id: ID!
): Group @deprecated
  groups: [Group!]! @deprecated
  handlesMoney: Boolean!
  hasBank: Boolean!
  hasBeneficiary: Boolean!
  hasBudget: Boolean!
  hasDefaultPhoto: Boolean!
  hasDonations: Boolean!
  id: ID!
  initializedApps: [AppEnum!]!
  isReferred: Boolean!
  isRunning: Boolean!
  isSuspicious: Boolean!
  isUnlisted: Boolean!
  isViewerMember: Boolean!
  isViewerOwner: Boolean!
  joinUrl: String!
  joinedFundraisers: [Fundraiser!]! @deprecated
  joinedFundraisersCount: Int! @deprecated
  latitude: Float
  longitude: Float
  name: String!
  noGroupFundraisers: CampaignNoGroupFundraisers! @deprecated
  organization: Organization
  owner: User
  payment(
  id: ID!
): Payment
  payments(
  first: Int
  after: String
  last: Int
  before: String
): PaymentConnection!
  pendingDisbursements: [CampaignPendingDisbursement!]!
  photoImage: String
  players: TeamPlayersInfo!
  playersCountEstimate: Int
  postalCode: String
  privacyLevel: PrivacyLevel
  province: String
  referralInfo: CampaignReferralInfo!
  referralPromotion: CampaignReferralPromotion
  seasonReminder: DateISO
  shopInitialized: DateISO
  site: Site!
  startsOn: DateISO!
  status: BeneficiaryStatus
  supportedIntentsPaginated(
  first: Int
  after: String
  last: Int
  before: String
  fundraiserUserId: ID
  onlyTeamSupports: Boolean = false
  filterByIntentCategory: IntentCategoryEnum
  includeTeamSupports: Boolean = false
  excludeSelfSupports: Boolean = false
  viewerIntentTypesFilter: [IntentTypeEnum!] = []
): IntentConnection!
  teamMembers: TeamMembersInfo!
  teamPicks(
  first: Int
  after: String
  last: Int
  before: String
): BrandConnection!
  testimonial: String
  upcomingEvents(
  first: Int
  after: String
  last: Int
  before: String
): EventConnection!
  url: String!
  viewerFundraiser: Fundraiser
}

Fields​

Campaign.accessCode ● String! non-null scalar​

Campaign's join code

Campaign.activeGroups ● [Group!]! non-null object​

A list of the campaign's groups which are not deleted

Campaign.activePlayerCount ● Int scalar​

The team's active player count

Campaign.allFilteredGroups ● [Group!] list object​

A list of the campaign's groups based on arguments

Campaign.allFilteredGroups.isActive ● Boolean scalar​
Campaign.allFilteredGroups.isDrafted ● Boolean scalar​

Campaign.amountRaised ● DollarFormats! non-null object​

Campaigns amount raised

Campaign.amountRaisedBreakdown ● AmountRaisedBreakdown! non-null object​

a breakdown of the amount raised by this campaign

Campaign.amountRaisedBreakdown.fundraiserId ● ID scalar​

Filter amount raised by Fundraiser ID

Campaign.amountRaisedBreakdown.onlyTeamSupports ● Boolean scalar​

Only include team supports (when not limiting by fundraiser)

Campaign.amountWithdrawnBreakdown ● AmountWithdrawnBreakdown! non-null object​

a breakdown of the funds withdrawn by this campaign

Campaign.beneficiary ● Beneficiary object​

Campaign's beneficiary

Campaign.brand ● Brand object​

The campaign's referral brand

Campaign.budgetApprovals ● Boolean! non-null scalar​

Does the division require budget approvals

Campaign.category ● CampaignCategory! non-null object​

Campaign's category

Campaign.city ● String scalar​

Campaign's city

Campaign.claimedAt ● DateISO scalar​

Date the URL was claimed by its owner.

Campaign.closeReport ● CampaignCloseReport! non-null object​

Information about a closed team

Campaign.country ● Country enum​

Campaign's country

Campaign.currency ● Currency! non-null enum​

Campaign's currency

Campaign.daysOrHoursLeftLabel ● String scalar​

Days or hours left for a campaign

Campaign.deadline ● DateISO scalar​

The deadline of a campaign

Campaign.defaultPlayerGoal ● DollarFormats object​

The team's default player goal amount.

Campaign.deletedGroups ● [Group!]! non-null object​

A list of the campaign's groups which are deleted

Campaign.description ● String scalar​

Campaigns's description

Campaign.directAmountRaised ● DollarFormats! non-null object​

how much did the campaign raise directly?

Campaign.division ● Organization object​

Campaign's category

Campaign.endsOn ● DateISO scalar​

The end date of a campaign

Campaign.externalPartnerRef ● String scalar​

External Partner's Ref/ID

Campaign.externalPartnerType ● ExternalPartnerType enum​

Which external partner is associated with Campaign

Campaign.filteredGroups ● [Group!] list object​

A list of the campaign's groups based on arguments, user

Campaign.filteredGroups.isActive ● Boolean scalar​
Campaign.filteredGroups.isDrafted ● Boolean scalar​

Campaign.fundraisers ● [Fundraiser!]! deprecated non-null object​

DEPRECATED: Use teamMembers.all field instead

A list of the campaign's fundraisers

Campaign.fundsDistributionMethod ● FundsDistributionMethod enum​

How campaign plans to distribute funds

Campaign.fundsObjective ● String scalar​

The team's funds objective description

Campaign.fundsObjectiveType ● String scalar​

The team's funds objective type

Campaign.goal ● DollarFormats object​

Campaigns's goal amount

Campaign.group ● Group deprecated object​

DEPRECATED: Use the group/player query instead

A group in a campaign

Campaign.group.id ● ID! non-null scalar​

Filter group by Group ID

Campaign.groups ● [Group!]! deprecated non-null object​

DEPRECATED: Use players.all field instead

A list of the campaign's groups

Campaign.handlesMoney ● Boolean! non-null scalar​

Does the campaign handle it's money?

Campaign.hasBank ● Boolean! non-null scalar​

Does this campaign use the bank app

Campaign.hasBeneficiary ● Boolean! non-null scalar​

Does campaign have a beneficiary?

Campaign.hasBudget ● Boolean! non-null scalar​

Does this campaign use the budget app

Campaign.hasDefaultPhoto ● Boolean! non-null scalar​

Does campaign have default photo?

Campaign.hasDonations ● Boolean! non-null scalar​

Does the campaign take donations?

Campaign.id ● ID! non-null scalar​

Campaigns's ID

Campaign.initializedApps ● [AppEnum!]! non-null enum​

The apps that the team has initialized

Campaign.isReferred ● Boolean! non-null scalar​

Is the campaign referred?

Campaign.isRunning ● Boolean! non-null scalar​

Is the campaign running?

Campaign.isSuspicious ● Boolean! non-null scalar​

Is campaign suspicious?

Campaign.isUnlisted ● Boolean! non-null scalar​

Is the campaign unlisted?

Campaign.isViewerMember ● Boolean! non-null scalar​

Is current viewer a member of campaign

Campaign.isViewerOwner ● Boolean! non-null scalar​

Is current viewer owner of campaign

Campaign.joinUrl ● String! non-null scalar​

URL to invite people with join the team.

Campaign.joinedFundraisers ● [Fundraiser!]! deprecated non-null object​

DEPRECATED: Use teamMembers.joined field instead

A list of just the joined fundraisers

Campaign.joinedFundraisersCount ● Int! deprecated non-null scalar​

DEPRECATED: Use teamMembers.joinedCount field instead

Count of joined fundraisers

Campaign.latitude ● Float scalar​

Campaign's latitude

Campaign.longitude ● Float scalar​

Campaign's longitude

Campaign.name ● String! non-null scalar​

Campaigns's name

Campaign.noGroupFundraisers ● CampaignNoGroupFundraisers! deprecated non-null object​

DEPRECATED: Use teamMembers.withUnassignedPlayers field instead

The campaign's fundraisers that don't belong to a group

Campaign.organization ● Organization object​

Campaign's category

Campaign.owner ● User object​

Team's owner

Campaign.payment ● Payment object​

Find a specific payment for this campaign

Campaign.payment.id ● ID! non-null scalar​

Payment ID to look up

Campaign.payments ● PaymentConnection! non-null object​

See payments made to this campaign

Campaign.payments.first ● Int scalar​

Returns the first n elements from the list.

Campaign.payments.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

Campaign.payments.last ● Int scalar​

Returns the last n elements from the list.

Campaign.payments.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

Campaign.pendingDisbursements ● [CampaignPendingDisbursement!]! non-null object​

A list of pending disbursements for campaign

Campaign.photoImage ● String scalar​

Campaign's photo image URL

Campaign.players ● TeamPlayersInfo! non-null object​

Team's players info

Campaign.playersCountEstimate ● Int scalar​

The team's player count estimate

Campaign.postalCode ● String scalar​

Campaign's Postal Code / Zip Code

Campaign.privacyLevel ● PrivacyLevel enum​

Campaign's privacy level

Campaign.province ● String scalar​

Campaign's province

Campaign.referralInfo ● CampaignReferralInfo! non-null object​

Team referral info

Campaign.referralPromotion ● CampaignReferralPromotion object​

Campaign's active referral promotion

Campaign.seasonReminder ● DateISO scalar​

Upcoming season reminder for campaign.

Campaign.shopInitialized ● DateISO scalar​

The date the shop app was initialized

Campaign.site ● Site! non-null object​

Campaign's site

Campaign.startsOn ● DateISO! non-null scalar​

Campaigns's starting date

Campaign.status ● BeneficiaryStatus enum​

Beneficiary approval status

Campaign.supportedIntentsPaginated ● IntentConnection! non-null object​

Supported intents, filtered optionally by user or fundraiser.

Campaign.supportedIntentsPaginated.first ● Int scalar​

Returns the first n elements from the list.

Campaign.supportedIntentsPaginated.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

Campaign.supportedIntentsPaginated.last ● Int scalar​

Returns the last n elements from the list.

Campaign.supportedIntentsPaginated.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

Campaign.supportedIntentsPaginated.fundraiserUserId ● ID scalar​

User ID of the fundraiser being supported

Campaign.supportedIntentsPaginated.onlyTeamSupports ● Boolean scalar​

Only include team supports (when not limiting by fundraiser)

Campaign.supportedIntentsPaginated.filterByIntentCategory ● IntentCategoryEnum enum​

Filter intents by a certain category of intent types

Campaign.supportedIntentsPaginated.includeTeamSupports ● Boolean scalar​

Whether or not to include team supports when limiting by fundraiser user (warning: this field is deprecated)

Campaign.supportedIntentsPaginated.excludeSelfSupports ● Boolean scalar​

Whether or not to exclude self supports when limiting by fundraiser user

Campaign.supportedIntentsPaginated.viewerIntentTypesFilter ● [IntentTypeEnum!] list enum​

Filter the viewer's intents by type, must have exclude self supports as false

Campaign.teamMembers ● TeamMembersInfo! non-null object​

Team's team members info

Campaign.teamPicks ● BrandConnection! non-null object​

Team's selected favorite brands

Campaign.teamPicks.first ● Int scalar​

Returns the first n elements from the list.

Campaign.teamPicks.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

Campaign.teamPicks.last ● Int scalar​

Returns the last n elements from the list.

Campaign.teamPicks.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

Campaign.testimonial ● String scalar​

Campaign's testimonial

Campaign.upcomingEvents ● EventConnection! non-null object​

See campaign upcoming events the viewer has been invited to

Campaign.upcomingEvents.first ● Int scalar​

Returns the first n elements from the list.

Campaign.upcomingEvents.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

Campaign.upcomingEvents.last ● Int scalar​

Returns the last n elements from the list.

Campaign.upcomingEvents.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

Campaign.url ● String! non-null scalar​

Campaign's url on the web

Campaign.viewerFundraiser ● Fundraiser object​

Current viewer's fundraiser on campaign

Returned by​

Campaign query ● CampaignJoinCodeSearch query

Member of​

Activity object ● Beneficiary object ● CampaignCreatePayload object ● CampaignEdge object ● CampaignLeavePayload object ● DeleteTeamRosterPayload object ● EditTeamRosterPayload object ● Event object ● ExternalTeam object ● Fundraiser object ● FundraiserUpdateRolesPayload object ● Giftcard object ● GiftcardIntent object ● Intent object ● OnboardingCaptainInvitedPayload object ● OnboardingCaptainSetGoalPayload object ● OnboardingCaptainSetObjectivePayload object ● OnboardingCaptainSetTeamPicksPayload object ● OnboardingCaptainViewResourcesPayload object ● OnboardingMemberEstimateEarningsPayload object ● OnboardingMemberSetFavoritesPayload object ● OnboardingMemberSetPlayerPayload object ● OnboardingMemberSetRolePayload object ● OrganizationCampaignsCreatePayload object ● PersonalAccount object ● ShopCloud object ● TeamCreatePayload object ● User object ● Viewer object

Implemented by​

CampaignGroupCreateUnion union ● CampaignGroupDeleteUnion union ● CampaignGroupUpdateUnion union ● CampaignInvitesCreateUnion union ● CampaignSetExternalPartnerUnion union ● CampaignSetFundsDistributionMethodUnion union ● CampaignTestimonialCreateUnion union ● CampaignUpdateCaptainUnion union ● CampaignUpdateUnion union ● CreateCampaignUnion union ● FlipgivePlayerFundraiserCreateUnion union ● InitializeBankUnion union ● LeaveCampaignUnion union ● TransferIntentUnion union