Viewer
Authenticated FlipGive User
type Viewer {
accessToken: String @deprecated
accessTokenExpiry: DateTimeISO @deprecated
activeCampaign: Campaign
activeFundraiser: Fundraiser
activeStatus: ActiveStatusEnum
announcements(
first: Int
after: String
last: Int
before: String
): AnnouncementConnection!
avatarImage(
masked: Boolean = true
): String
beneficiary: BudgetBeneficiary
budgetBeneficiary: BudgetBeneficiary
budgetInfo: ViewerBudgetInfo!
campaign(
id: ID!
): Campaign
campaigns: [Campaign!]!
country: Country!
currency: Currency!
defaultPartnerCampaignId: ID @deprecated
email: String!
endedCampaigns: [Campaign!]!
event(
id: ID!
): Event!
externalTeams(
externalPartnerType: ExternalPartnerType!
): [ExternalTeam!]!
favoriteBrands(
first: Int!
currency: Currency
siteId: ID
): [Brand!]!
favoriteBrandsCount(
currency: Currency
siteId: ID
): Int
firstName(
masked: Boolean = true
): String!
giftcards(
ids: [ID!]
): [Giftcard!]! @deprecated
giftcardsPaginated(
first: Int
after: String
last: Int
before: String
ids: [ID!]
sortBy: GiftcardSortEnum
nameContains: String
withBalance: Boolean
giftcardTypes: [GiftcardType!]
giftcardType: GiftcardTypeFilter
): GiftcardConnection!
hasValidTeamsnapToken: Boolean!
hidePurchaseActivity: Boolean!
id: ID!
iframeUrl: String
intents: [Intent!]! @deprecated
intentsPaginated(
first: Int
after: String
last: Int
before: String
filterBy: IntentFilterByEnum
onlyActiveCurrency: Boolean = false
): IntentConnection!
isAdmin: Boolean!
isCaptain: Boolean
isCaptainable: Boolean
isMerchantAdmin: Boolean!
isOrgAdmin: Boolean!
isSiteAdmin: Boolean!
joinedAt: DateTimeISO!
lastName(
masked: Boolean = true
): String
limitedProfile: Boolean
linkedCards: [LinkedCard!]!
mobileAppFlags: ViewerMobileAppFlags!
name: String
notifications(
first: Int!
beforeId: ID
): [Notification!]! @deprecated
notificationsPaginated(
first: Int!
after: String
last: Int
before: String
): NotificationConnection!
notifySupport: Boolean!
notifyUpdate: Boolean!
onboarding: UserOnboarding @deprecated
pastEvents(
first: Int
after: String
last: Int
before: String
): EventConnection!
perishableToken: String!
personalAccount: PersonalAccount!
privacyLevel: PrivacyLevel
referralSentence(
referralCode: String!
): String
refreshToken: String @deprecated
runningCampaigns(
currency: Currency
): [Campaign!]!
savedAddresses(
first: Int
after: String
last: Int
before: String
): AddressConnection!
shoppingTripsCount: Int!
stripeCards(
currency: Currency
): [StripeCard!]!
teamOnboardingInfo: TeamOnboardingInfo!
teamsCount: Int!
totalAmountRaised: DollarFormats!
unreadNotificationCount: Int!
unseenNotificationCount: Int!
unsubscribedAt: DateTimeISO
upcomingEvents(
first: Int
after: String
last: Int
before: String
): EventConnection!
}
Fields
Viewer.accessToken ● String deprecated scalar
DEPRECATED: Please use the AuthenticatePayload to retrieve this value.User's API access token
Viewer.accessTokenExpiry ● DateTimeISO deprecated scalar
DEPRECATED: Please use the AuthenticatePayload to retrieve this value.User's API access token expiry
Viewer.activeCampaign ● Campaign object
Active campaign on FlipGive or partners
Viewer.activeFundraiser ● Fundraiser object
Active campaign's fundraiser on FlipGive or partners
Viewer.activeStatus ● ActiveStatusEnum enum
The active fundraising status of the viewer
Viewer.announcements ● AnnouncementConnection! non-null object
See my announcements
Viewer.announcements.first●IntscalarReturns the first n elements from the list.
Viewer.announcements.after ● String scalar
Returns the elements in the list that come after the specified cursor.
Viewer.announcements.last ● Int scalar
Returns the last n elements from the list.
Viewer.announcements.before ● String scalar
Returns the elements in the list that come before the specified cursor.
Viewer.avatarImage ● String scalar
The url of the user's avatar
Viewer.avatarImage.masked●BooleanscalarShould return masked?
Viewer.beneficiary ● BudgetBeneficiary object
Budget beneficiary for viewer
Viewer.budgetBeneficiary ● BudgetBeneficiary object
Budget beneficiary for team
Viewer.budgetInfo ● ViewerBudgetInfo! non-null object
Budget fields for viewer
Viewer.campaign ● Campaign object
A user's campaign by ID
Viewer.campaign.id●ID!non-null scalarThe ID of the user's campaign
Viewer.campaigns ● [Campaign!]! non-null object
A list of the user's active campaigns
Viewer.country ● Country! non-null enum
The country for this user
Viewer.currency ● Currency! non-null enum
The default currency for this user
Viewer.defaultPartnerCampaignId ● ID deprecated scalar
DEPRECATED: Please use the activeCampaign field to access the current active campaign for user across all FlipGive partner sites.The ID of the user's default partner campaign
Viewer.email ● String! non-null scalar
User's email address
Viewer.endedCampaigns ● [Campaign!]! non-null object
A list of the user's ended campaigns
Viewer.event ● Event! non-null object
Access a specific event for this user
Viewer.event.id●ID!non-null scalarWhich event to access
Viewer.externalTeams ● [ExternalTeam!]! non-null object
External teams linked to this user thorugh SSO
Viewer.externalTeams.externalPartnerType●ExternalPartnerType!non-null enumWhich external partner to return external teams for
Viewer.favoriteBrands ● [Brand!]! non-null object
Favorite brands for this user
Viewer.favoriteBrands.first●Int!non-null scalarThe number of brands to return, maximum: 50
Viewer.favoriteBrands.currency ● Currency enum
Viewer.favoriteBrands.siteId ● ID scalar
Viewer.favoriteBrandsCount ● Int scalar
Number of favorite brands for this user
Viewer.favoriteBrandsCount.currency●Currencyenum
Viewer.favoriteBrandsCount.siteId ● ID scalar
Viewer.firstName ● String! non-null scalar
User's first name
Viewer.firstName.masked●BooleanscalarShould return masked?
Viewer.giftcards ● [Giftcard!]! deprecated non-null object
DEPRECATED: Use giftcardsPaginated field instead.A list of the user's giftcards
Viewer.giftcards.ids●[ID!]list scalarArray of IDs for specific giftcards to return
Viewer.giftcardsPaginated ● GiftcardConnection! non-null object
A list of the user's giftcards
Viewer.giftcardsPaginated.first●IntscalarReturns the first n elements from the list.
Viewer.giftcardsPaginated.after ● String scalar
Returns the elements in the list that come after the specified cursor.
Viewer.giftcardsPaginated.last ● Int scalar
Returns the last n elements from the list.
Viewer.giftcardsPaginated.before ● String scalar
Returns the elements in the list that come before the specified cursor.
Viewer.giftcardsPaginated.ids ● [ID!] list scalar
Array of IDs for specific giftcards to return
Viewer.giftcardsPaginated.sortBy ● GiftcardSortEnum enum
The field name that giftcard data should be sorted based on
Viewer.giftcardsPaginated.nameContains ● String scalar
Search giftcards by name
Viewer.giftcardsPaginated.withBalance ● Boolean scalar
Show giftcards with a balance
Viewer.giftcardsPaginated.giftcardTypes ● [GiftcardType!] list enum
Types of giftcards to return
Viewer.giftcardsPaginated.giftcardType ● GiftcardTypeFilter enum
Option for filtering the giftcard list [DEPRECATED use giftcardTypes argument]
Viewer.hasValidTeamsnapToken ● Boolean! non-null scalar
Does the user have a valid teamsnap token
Viewer.hidePurchaseActivity ● Boolean! non-null scalar
Hide user's shopping activity.
Viewer.id ● ID! non-null scalar
User's ID
Viewer.iframeUrl ● String scalar
VoPay embed URL
Viewer.intents ● [Intent!]! deprecated non-null object
DEPRECATED: Use intentsPaginated field instead.A list of the user's intents
Viewer.intentsPaginated ● IntentConnection! non-null object
The viewer's intents
Viewer.intentsPaginated.first●IntscalarReturns the first n elements from the list.
Viewer.intentsPaginated.after ● String scalar
Returns the elements in the list that come after the specified cursor.
Viewer.intentsPaginated.last ● Int scalar
Returns the last n elements from the list.
Viewer.intentsPaginated.before ● String scalar
Returns the elements in the list that come before the specified cursor.
Viewer.intentsPaginated.filterBy ● IntentFilterByEnum enum
Filter by pending, or supported intents
Viewer.intentsPaginated.onlyActiveCurrency ● Boolean scalar
Filter intents by the current user's active currency
Viewer.isAdmin ● Boolean! non-null scalar
Is the user an admin?
Viewer.isCaptain ● Boolean scalar
Is Captain
Viewer.isCaptainable ● Boolean scalar
Is Captainable
Viewer.isMerchantAdmin ● Boolean! non-null scalar
viewer merchant admin?
Viewer.isOrgAdmin ● Boolean! non-null scalar
viewer organization admin?
Viewer.isSiteAdmin ● Boolean! non-null scalar
viewer site admin?
Viewer.joinedAt ● DateTimeISO! non-null scalar
User created date
Viewer.lastName ● String scalar
User's last name
Viewer.lastName.masked●BooleanscalarShould return masked?
Viewer.limitedProfile ● Boolean scalar
Hide photo and last name?
Viewer.linkedCards ● [LinkedCard!]! non-null object
Linked cards for this user
Viewer.mobileAppFlags ● ViewerMobileAppFlags! non-null object
Various values and information for how the mobile app should function for this viewer
Viewer.name ● String scalar
User's full name
Viewer.notifications ● [Notification!]! deprecated non-null object
DEPRECATED: Use notificationsPaginated field instead.Returns a list of notifications, max: 50
Viewer.notifications.first●Int!non-null scalarThe number of notifications to return
Viewer.notifications.beforeId ● ID scalar
Start pulling notifications before this ID
Viewer.notificationsPaginated ● NotificationConnection! non-null object
Returns a paginated list of notifications
Viewer.notificationsPaginated.first●Int!non-null scalarThe number of notifications to return
Viewer.notificationsPaginated.after ● String scalar
Returns the elements in the list that come after the specified cursor.
Viewer.notificationsPaginated.last ● Int scalar
Returns the last n elements from the list.
Viewer.notificationsPaginated.before ● String scalar
Returns the elements in the list that come before the specified cursor.
Viewer.notifySupport ● Boolean! non-null scalar
Notify user of support activities?
Viewer.notifyUpdate ● Boolean! non-null scalar
Notify user of updates?
Viewer.onboarding ● UserOnboarding deprecated object
DEPRECATED: Onboarding flow has changed, please use the teamOnboardingInfo field instead.User's onboarding info
Viewer.pastEvents ● EventConnection! non-null object
See my past events
Viewer.pastEvents.first●IntscalarReturns the first n elements from the list.
Viewer.pastEvents.after ● String scalar
Returns the elements in the list that come after the specified cursor.
Viewer.pastEvents.last ● Int scalar
Returns the last n elements from the list.
Viewer.pastEvents.before ● String scalar
Returns the elements in the list that come before the specified cursor.
Viewer.perishableToken ● String! non-null scalar
A perishable token to reset the password
Viewer.personalAccount ● PersonalAccount! non-null object
Information for the viewer's personal account
Viewer.privacyLevel ● PrivacyLevel enum
Viewer's privacy level
Viewer.referralSentence ● String scalar
A sentence describing the referal incentive for a given referral code
Viewer.referralSentence.referralCode●String!non-null scalarThe user's referral code
Viewer.refreshToken ● String deprecated scalar
DEPRECATED: Please use the AuthenticatePayload to retrieve this value.User's API refresh token
Viewer.runningCampaigns ● [Campaign!]! non-null object
A list of the user's running campaigns
Viewer.runningCampaigns.currency●Currencyenum
Viewer.savedAddresses ● AddressConnection! non-null object
A list of the user's saved addresses
Viewer.savedAddresses.first●IntscalarReturns the first n elements from the list.
Viewer.savedAddresses.after ● String scalar
Returns the elements in the list that come after the specified cursor.
Viewer.savedAddresses.last ● Int scalar
Returns the last n elements from the list.
Viewer.savedAddresses.before ● String scalar
Returns the elements in the list that come before the specified cursor.
Viewer.shoppingTripsCount ● Int! non-null scalar
Total shopping trips a viewer has made
Viewer.stripeCards ● [StripeCard!]! non-null object
Saved Stripe cards for this user
Viewer.stripeCards.currency●Currencyenum
Viewer.teamOnboardingInfo ● TeamOnboardingInfo! non-null object
User's team onboarding info
Viewer.teamsCount ● Int! non-null scalar
Total teams the viewer has been a part of
Viewer.totalAmountRaised ● DollarFormats! non-null object
viewer total amount raised
Viewer.unreadNotificationCount ● Int! non-null scalar
Number of unread notifications for this user
Viewer.unseenNotificationCount ● Int! non-null scalar
Number of unseen notifications for this user
Viewer.unsubscribedAt ● DateTimeISO scalar
Unsubscribed from marketing?
Viewer.upcomingEvents ● EventConnection! non-null object
See my upcoming events
Viewer.upcomingEvents.first●IntscalarReturns the first n elements from the list.
Viewer.upcomingEvents.after ● String scalar
Returns the elements in the list that come after the specified cursor.
Viewer.upcomingEvents.last ● Int scalar
Returns the last n elements from the list.
Viewer.upcomingEvents.before ● String scalar
Returns the elements in the list that come before the specified cursor.
Returned by
Viewer query
Member of
AuthenticatePayload object ● BudgetTermsAgreePayload object ● CampaignCreatePayload object ● CampaignJoinPayload object ● EditTeamRosterPayload object ● OnboardingCaptainInvitedPayload object ● OnboardingCaptainSetGoalPayload object ● OnboardingCaptainSetObjectivePayload object ● OnboardingCaptainSetTeamPicksPayload object ● OnboardingCaptainViewResourcesPayload object ● OnboardingMemberEstimateEarningsPayload object ● OnboardingMemberSetFavoritesPayload object ● OnboardingMemberSetPlayerPayload object ● OnboardingMemberSetRolePayload object ● OnboardingSkipStepPayload object ● ShopCloud object ● TeamCreatePayload object
Implemented by
ActivityMarkAllNotificationsReadUnion union ● ActivityMarkAllNotificationsSeenUnion union ● ActivityMarkNotificationsReadUnion union ● DismissAnnouncementUnion union ● StripeCardCreateUnion union ● StripeCardDeleteUnion union ● TransferFundsUnion union ● ViewerAddFavoriteBrandsUnion union ● ViewerAnswerOnboardingQuestionUnion union ● ViewerRemoveLinkedCardUnion union ● ViewerReorderFavoriteBrandsUnion union ● ViewerSetActiveCampaignUnion union ● ViewerSettingsUpdateUnion union ● ViewerSubmitMobileAppReviewUnion union