Schema Types

Table of Contents

Query
Mutation
Objects
Inputs
Enums
Scalars
Interfaces
- ApplicationRequirement
- Requirement

Query

The root query type for the OwlFlow API. Operations are grouped into namespaced fields to provide a clear and organized contract.

Field	Type	Description
billing	BillingQuery!	Entrypoint for billing, subscription management, and payment configuration.
health	String!	Returns a simple string to verify the operational status of the API.
me	Account	The current authenticated user's account details. This is a convenience alias for `viewer { account }`.
references	ReferencesQuery!	Entrypoint for accessing static reference data such as dictionaries and geographic lookups.
scholarships	ScholarshipsQuery!	Entrypoint for searching, listing, and retrieving scholarship information.
viewer	Viewer!	Contextual information and operations for the current requester (viewer). Includes access to "my" data like applications and profile stats.

Mutation

The root mutation type for the OwlFlow API. Mutations are grouped into namespaced fields based on their functional domain.

Field	Type	Description
auth	AuthMutations!	Operations related to user authentication, registration, and security.
billing	BillingMutations!	Operations for processing payments, managing subscriptions, and applying discounts.
deleteAccount	Boolean!	Permanently deletes the specified account and all associated data. This action is irreversible.
id	ID!
scholarships	ScholarshipsMutations!	Operations for interacting with scholarships, managing applications, and reporting content.
viewer	ViewerMutations!	Operations specific to the currently authenticated user's profile and session.

Objects

Account

Represents a user account and their associated profile information. This is the central entity for student data on the platform.

Field	Type	Description
address	Address	Physical mailing address.
careerGoal	String	The user's primary career or professional goal.
createdAt	DateTime!	Timestamp of when the account was created.
dateOfBirth	DateTime	The user's date of birth. Used for age-based eligibility.
documents	[Document!]!	A collection of documents (e.g., transcripts, resumes) uploaded by the user.
education	[Education!]!	A list of the user's educational history and current enrollment status.
email	String!	Primary email address used for login and notifications.
ethnicity	String	The user's ethnic background. Used for diversity-based eligibility.
firstName	String!	The user's first name.
hobbies	[String!]	A list of the user's personal interests and hobbies.
id	ID!	Unique identifier for the account.
lastName	String!	The user's last name.
membership	Membership	Details about the user's platform membership or subscription plan.
militaryAffiliation	String	The user's current or past military service status.
phone	String	Primary contact phone number.
profileCompletion	ProfileCompletion!	Provides metrics and guidance on how complete the user's profile is.
socialAccounts	[SocialAccount!]!	A list of third-party social accounts linked to this user.
updatedAt	DateTime!	Timestamp of when the account or profile was last updated.

AccountFile

Information about a file stored on the platform.

Field	Type	Description
createdAt	DateTime!	Timestamp when the file was uploaded.
id	ID!	Unique identifier for the file.
mimeType	String	The MIME type of the file (e.g., "application/pdf").
name	String!	System-generated or display name for the file.
originalName	String	The name of the file as it was originally uploaded.
path	String!	The internal storage path of the file.
size	Int	The size of the file in bytes.
url	String	The public-facing URL to access the file.

Address

A physical mailing or billing address.

Field	Argument	Type	Description
city		String!
country		String!
state		String!
street		String!
zipCode		String!

AllDictionaries

A consolidated collection of all dictionary data required to populate forms. This is the most efficient way to load data for registration or profile editing.

Field	Type	Description
careerGoals	[CareerGoal!]!	Common career and professional goals.
citizenship	[DictionaryItem!]!	Options for user citizenship status.
countries	[DictionaryItem!]!	A list of all supported countries.
degreeTypes	[DegreeType!]!	Broad types of academic degrees.
degrees	[Degree!]!	Specific academic degree titles.
ethnicities	[Ethnicity!]!	Options for ethnic background.
genders	[DictionaryItem!]!	Options for gender identity.
highSchools	[HighSchool!]!	Searchable list of high schools and colleges.
limit	Int	The maximum number of results to return.
search	String	Search term to match against school names.
state	String	Filter by state abbreviation.
type	SchoolType	Filter by the type of institution.
militaryAffiliations	[DictionaryItem!]!	Options for military service status and affiliation.
schoolLevels	[SchoolLevel!]!	Standard educational levels.
states	[State!]!	A list of all states/provinces.

Application

A student's application for a specific scholarship. Tracks the progress of completing requirements and the final submission status.

Field	Type	Description
createdAt	DateTime!	When the application record was first created.
id	ID!	Unique identifier for the application.
requirementMap	[RequirementMapEntry!]!	A mapping between scholarship requirements and the user's specific responses.
scholarship	Scholarship!	The scholarship details.
scholarshipId	ID!	The ID of the scholarship being applied for.
status	ApplicationStatus!	Current progress or outcome status of the application.
updatedAt	DateTime	When the application or its requirement responses were last updated.

ApplicationConnection

A paginated collection of scholarship applications.

Field	Type	Description
nodes	[Application!]!	The list of application objects for the current page.
pageInfo	PageInfo!	Pagination metadata.
totalCount	Int!	The total number of applications matching the criteria.

ApplicationFile

A student's file upload for a file requirement.

Field	Type	Description
account	Account	The account that uploaded this file.
createdAt	DateTime!
file	AccountFile!	Details of the uploaded file.
id	ID!
requirement	RequirementFile	The original file requirement.
source	String
updatedAt	DateTime

ApplicationGoal

A student's selection for a goal requirement.

Field	Type	Description
account	Account	The account that provided this selection.
createdAt	DateTime!
description	String	The written description for the selected goal.
id	ID!
requirement	RequirementGoal	The original goal requirement.
source	String
updatedAt	DateTime

ApplicationImage

A student's image upload for an image requirement.

Field	Type	Description
account	Account	The account that uploaded this image.
createdAt	DateTime!
file	AccountFile!	Details of the uploaded image.
id	ID!
requirement	RequirementImage	The original image requirement.
source	String
updatedAt	DateTime

ApplicationInput

A student's response for a single input requirement.

Field	Type	Description
account	Account	The account that provided this response.
createdAt	DateTime!
id	ID!
requirement	RequirementInput	The original input requirement.
source	String
text	String	The text value provided.
updatedAt	DateTime

ApplicationPreviewApplicationData

Metadata for the final application submission.

Field	Type	Description
body	String	Body text of the submission email or message.
recipient	String	Designated recipient of the application.
subject	String	Subject line for the application submission.

ApplicationPreviewData

Snapshot of application data used for final review before submission.

Field	Type	Description
applicationData	ApplicationPreviewApplicationData	Metadata about the final submission package, such as recipient or subject line.
applicationType	String	The internal identifier for the application process type.
fields	[ApplicationPreviewField!]	A list of key-value pairs representing common application fields (e.g., Name, Email).
requirements	ApplicationPreviewRequirements	A grouped collection of requirement responses (essays, files, etc.).

ApplicationPreviewField

A single field in the application preview, typically representing profile data.

Field	Argument	Type	Description
label		String!	Display label for the field (e.g., "Full Name").
val		String	The current value for this field.

ApplicationPreviewRequirements

Grouped requirement responses for the application preview.

Field	Type	Description
ApplicationFile	[ApplicationFile!]	Uploaded files for file-based requirements.
ApplicationGoal	[ApplicationGoal!]	Selected career or educational goals.
ApplicationImage	[ApplicationImage!]	Uploaded images for image-based requirements.
ApplicationInput	[ApplicationInput!]	Responses for input-based requirements.
ApplicationSpecialEligibility	[ApplicationSpecialEligibility!]	Responses for special eligibility requirements.
ApplicationSurvey	[ApplicationSurvey!]	Answer sets for survey requirements.
ApplicationText	[ApplicationText!]	Written responses for text/essay requirements.

ApplicationSpecialEligibility

A student's confirmation for a special eligibility requirement.

Field	Type	Description
account	Account	The account that provided this confirmation.
createdAt	DateTime!
id	ID!
requirement	RequirementSpecialEligibility	The original eligibility requirement.
source	String
specialEligibilityValue	String	The confirmed value or status.
updatedAt	DateTime

ApplicationSurvey

A student's set of answers for a survey requirement.

Field	Type	Description
account	Account	The account that provided these answers.
answers	JSON!	The answers provided for the survey questions, stored as a JSON object.
createdAt	DateTime!
id	ID!
requirement	RequirementSurvey	The original survey requirement.
source	String
updatedAt	DateTime

ApplicationText

A student's written response or essay for a text requirement.

Field	Type	Description
account	Account	The account that provided this response.
createdAt	DateTime!
extra	JSON	Additional metadata or structured data for the response.
file	AccountFile	Reference to an uploaded file if the response was provided as a document.
id	ID!
requirement	RequirementText	The original requirement this response fulfills.
source	String
text	String	The written text content.
updatedAt	DateTime

AuthMutations

Authentication and account security operations.

Field	Type	Description
changePassword	Boolean!	Changes the password for the currently authenticated user.
input	PasswordChangeInput!
connectSocialAccount	AuthResponse!	Links a social media account to the current user's profile.
input	ConnectSocialAccountInput!
createUser	UserCreationResult!	Registers a new user account. This is the primary entrypoint for the registration funnel.
input	CreateUserInput!
deleteDocument	Boolean!	Permanently removes a document from the user's profile.
id	ID!
disconnectSocialAccount	Boolean!	Removes the link between a social media account and the user's profile.
provider	SocialProvider!
googleAuth	AuthResponse!	Authenticates or registers a user using Google OAuth.
input	GoogleAuthInput!
login	AuthResponse!	Authenticates a user using email and password.
input	LoginInput!
logout	Boolean!	Ends the current user session and invalidates the authentication token.
refreshToken	AuthResponse!	Issues a new authentication token to replace an expiring one.
requestPasswordReset	Boolean!	Triggers a password reset email to be sent to the user.
input	PasswordResetInput!
resetPassword	Boolean!	Sets a new password using a valid reset token.
input	ResetPasswordInput!
uploadDocument	Document!	Uploads a document (e.g., resume, transcript) to the user's profile.
file	Upload!	The file to be uploaded.
type	String!	The category of the document being uploaded (e.g., "TRANSCRIPT").

AuthResponse

The response from a successful authentication operation. Includes the access token and the authenticated user's account details.

Field	Type	Description
expiresAt	DateTime!	The timestamp when the authentication token expires.
token	String!	The authentication token to be used in subsequent requests.
user	Account!	The authenticated user's account information.

AutomaticScholarship

Details of a scholarship that is automatically handled by the platform.

Field	Type	Description
expirationDate	DateTime	When the automatic application period ends.
id	ID!	Unique identifier.
startDate	DateTime	When the automatic application period starts.
timezone	String	Timezone for the dates.
title	String!	Title of the scholarship.

BillingMutations

Namespace for all mutations related to billing and subscriptions.

Field	Type	Description
applyDiscount	Boolean!	Applies an available discount to the current user's active subscription.
cancelMembership	Boolean!	Permanently cancels an active membership subscription.
membershipId	ID!
setSubscriptionMaintenanceMode	Boolean!	Enables or disables maintenance mode for a subscription. Maintenance mode can be used to temporarily pause subscription features.
isMaintenanceMode	Boolean!
subscriptionId	ID!
submitSubscriptionCancellationSurvey	Boolean!	Submits a survey response when a user attempts to cancel their subscription.
input	BillingSubscriptionCancellationSurveyInput!

BillingPackage

A subscription package offered to users. Contains pricing, features, and display metadata.

Field	Type	Description
billingAgreement	String	The legal or descriptive text for the billing agreement.
buttonCSS	String	Optional CSS classes or styles for the purchase button.
buttonTextForPackage	String	The text to display on the purchase button.
contactUsLink	Boolean	Whether to display a "Contact Us" link instead of a purchase button.
discountPrice	Float	A discounted price, if applicable.
displayDescriptionItems	[String!]!	A list of key features or benefits to display to the user.
displayMessage	String	A short marketing message for the package.
displaySuccessMessage	String	A message to display after a successful purchase.
expirationPeriodType	String	The unit of time for expiration (e.g., "MONTH", "YEAR").
expirationPeriodValue	Int	The number of units until expiration.
expirationType	String	The type of expiration for the package (e.g., "finite", "infinite").
freeTrialPeriodText	String	Descriptive text explaining the free trial terms.
id	ID!	Unique identifier for the package.
isContactUs	Boolean	Whether the user should be directed to contact support for this package.
isFreeTrial	Boolean	Whether this package includes a free trial period.
isFreemium	Boolean	Whether this is a freemium or basic package.
isMarked	Boolean	Whether this package is highlighted or recommended.
isRecurrent	Boolean	Whether this package uses recurring billing.
name	String!	Display name of the package.
paypalExpirationType	String	Specific expiration type for PayPal-based subscriptions.
price	Float	The total price of the package in USD.
pricePerMonth	Float	The equivalent price per month in USD.
recurrentPriceMessage	String	A descriptive message for recurrent billing (e.g., "$19.99 billed monthly").

BillingPaymentPopupDetails

Configuration and data required to render the payment interface.

Field	Type	Description
convertToFreemiumEnabled	Boolean!	Whether the option to convert to a freemium plan is enabled.
disclaimerEnabled	Boolean!	Whether a legal or informational disclaimer should be displayed.
disclaimerText	String	The text of the disclaimer.
packages	[BillingPackage!]!	A list of available subscription packages.
paymentMethodName	String!	The name of the default or selected payment method.
popupTitle	String	The title for the payment popup.
stripePublishableKey	String	The publishable key for Stripe integration.

BillingQuery

Namespace for all queries related to billing, subscriptions, and special offers.

Field	Type	Description
package	BillingPackage	Retrieves details for a specific billing package by its ID.
id	ID!
paymentPopupDetails	BillingPaymentPopupDetails!	Retrieves payment configuration and available packages for the current user. Used to render the premium upgrade popup.
specialOfferPage	BillingSpecialOfferPage!	Retrieves a special offer landing page and its associated package by URL.
url	String!
specialOfferPages	BillingSpecialOfferPageConnection!	Lists all available special offer landing pages.
pagination	PaginationInput

BillingSpecialOfferPage

A marketing landing page for a special subscription offer.

Field	Type	Description
description	String	The primary marketing copy or description.
iconTitle1	String	Title for the first marketing icon/feature.
iconTitle2	String	Title for the second marketing icon/feature.
iconTitle3	String	Title for the third marketing icon/feature.
id	ID!	Unique identifier for the page.
metaAuthor	String	SEO: Author metadata.
metaDescription	String	SEO: Description metadata.
metaKeywords	String	SEO: Keywords metadata.
metaTitle	String	SEO: Title metadata.
package	BillingPackage	The specific billing package associated with this offer.
scrollToText	String	Optional text for an auto-scroll or call-to-action link.
title	String	The page title.
url	String	The unique URL slug for the landing page.

BillingSpecialOfferPageConnection

A paginated collection of special offer pages.

Field	Argument	Type	Description
nodes		[BillingSpecialOfferPage!]!
pageInfo		PageInfo!
totalCount		Int!

CareerGoal

Career and professional path options.

Field	Type	Description
category	String	The broad category this career goal belongs to.
description	String
id	ID!
isActive	Boolean!
name	String!
order	Int
value	String!

CategoryStats

Aggregated statistics for a specific scholarship category.

Field	Type	Description
count	Int!	Total number of scholarships in this category.
name	String!	Name of the category.
totalAmount	Float!	Total dollar amount of all scholarships in this category.

Degree

Academic degree titles and levels.

Field	Type	Description
description	String
id	ID!
isActive	Boolean!
level	String	The educational level required for this degree (e.g., "Undergraduate").
name	String!
order	Int
value	String!

DegreeType

Broad categories of academic degrees.

Field	Argument	Type	Description
category		String
description		String
id		ID!
isActive		Boolean!
name		String!
order		Int
value		String!

DictionaryItem

A generic item from a platform dictionary (e.g., country list, gender options). Used to populate dropdowns and selection lists in the UI.

Field	Type	Description
description	String	An optional description providing more context.
id	ID!	Unique internal identifier.
isActive	Boolean!	Whether the item is currently active and should be displayed to users.
name	String!	The human-readable name of the item.
order	Int	The preferred display order for this item.
value	String!	The machine-readable value of the item.

Document

A document uploaded to the platform, such as a transcript or essay.

Field	Type	Description
id	ID!	Unique identifier for the document.
name	String!	The display name of the document.
type	String!	The type or category of the document (e.g., "TRANSCRIPT").
uploadedAt	DateTime!	When the document was uploaded.
url	String!	The public URL to access the document content.

Education

Details of an educational attainment or current enrollment.

Field	Type	Description
degree	String	The degree or qualification pursued or earned.
fieldOfStudy	String	The primary area of study.
gpa	Float	The Grade Point Average (GPA) achieved.
graduationDate	DateTime	The date of graduation or expected graduation.
id	ID!	Unique identifier for the education entry.
schoolLevel	String!	The level of education (e.g., "High School", "College").
schoolName	String!	The name of the educational institution.

Eligibility

A specific eligibility rule that defines who can apply for a scholarship.

Field	Type	Description
description	String	A human-readable explanation of the eligibility requirement.
field	EligibilityField!	Information about the user profile field this rule checks against.
id	ID!	Unique identifier for the eligibility rule.
isOptional	Boolean!	Whether this criterion is optional or mandatory for application.
operator	EligibilityOperator!	The logic used for comparison (e.g., EQUALS, GREATER_THAN).
type	EligibilityType!	The type of criterion being checked (e.g., GPA, School Level).
value	String!	The target value or threshold for this criterion.

EligibilityField

Metadata about a user profile field used in eligibility logic.

Field	Type	Description
id	String!	Unique internal identifier for the field.
name	String!	Human-readable name of the field.
type	String!	The data type of the field (e.g., string, number, date).

EssayDiffResult

The result of recording an essay diff.

Field	Argument	Type	Description
recordId		String	Internal ID for the recorded diff record.
saved		Boolean!	Whether the diff was successfully recorded.

EssayGenerationResult

The result of an AI essay generation request.

Field	Argument	Type	Description
text		String	The generated draft text.

Ethnicity

Details of an ethnic background category.

Field	Argument	Type	Description
description		String
id		ID!
isActive		Boolean!
name		String!
order		Int
value		String!

EthnicityConnection

A paginated collection of ethnicity options.

Field	Argument	Type	Description
edges		[EthnicityEdge!]!
pageInfo		PageInfo!
totalCount		Int!

EthnicityEdge

Field	Argument	Type	Description
cursor		String!
node		Ethnicity!

GraphQLError

Standard error information for API operations.

Field	Type	Description
code	String!	A stable error code for programmatic handling.
extensions	JSON	Additional contextual metadata about the error.
message	String!	A human-readable description of the error.
path	[String!]	The path to the field that caused the error.

HighSchool

Details of a high school or secondary educational institution.

Field	Argument	Type	Description
city		String
country		String
id		ID!
isActive		Boolean!
name		String!
state		String
stateId		ID
zipCode		String

HighSchoolConnection

A paginated collection of high school options.

Field	Argument	Type	Description
edges		[HighSchoolEdge!]!
pageInfo		PageInfo!
totalCount		Int!

HighSchoolEdge

Field	Argument	Type	Description
cursor		String!
node		HighSchool!

IpData

Geographic and network information derived from an IP address.

Field	Type	Description
city	String!	The name of the city.
country	String!	The name of the country.
countryCode	String!	The standard ISO country code.
region	String!	The name of the region or state.
regionCode	String!	The standard region or state code.
zip	String!	The postal or zip code.

Membership

The current status and details of a user's platform membership.

Field	Type	Description
expiresAt	DateTime	When the current membership is set to expire.
id	ID!	Unique identifier for the membership.
package	Package	The subscription package associated with this membership.
status	String!	The current status of the membership (e.g., "ACTIVE", "EXPIRED").

OnboardingPlugin

An onboarding "plugin" representing an external offer, survey, or integration.

Field	Type	Description
extra	JSON	Additional configuration or metadata for rendering the plugin.
id	ID!	Unique identifier for the plugin.
name	String!	The display name of the plugin or offer.
text	String!	Descriptive text explaining the offer or required action.

OnboardingPluginSubmissionResult

The result of an onboarding plugin submission.

Field	Argument	Type	Description
extra		JSON	Any updated metadata or confirmation data from the plugin provider.
id		ID!	The ID of the plugin.

Package

A subscription or membership plan offered by the platform.

Field	Type	Description
features	[String!]!	A list of feature names or keys included in the package.
id	ID!	Unique identifier for the package.
name	String!	The display name of the package.
scholarshipsCount	Int!	The number of scholarship applications or features included in this package.

PageInfo

Pagination information for collections.

Field	Type	Description
endCursor	String	The cursor for the last item in the current page.
hasNextPage	Boolean!	Indicates if there are more results available after the current page.
hasPreviousPage	Boolean!	Indicates if there are more results available before the current page.
startCursor	String	The cursor for the first item in the current page.

PostEligibilityResult

The result of a pre-registration eligibility check.

Field	Argument	Type	Description
success		Boolean!	Whether the user is likely eligible for scholarships on the platform.

ProfileCompletion

Metrics and actionable steps for completing a user profile.

Field	Type	Description
completedSections	[String!]!	Names of the profile sections that are considered complete.
missingSections	[String!]!	Names of the profile sections that still need information.
nextSteps	[String!]!	Specific recommendations for what the user should do next to improve their profile.
percentage	Float!	The percentage of the profile that has been filled in.

ProfileProgress

Tracks the completeness of a user's profile and its impact on scholarship opportunities.

Field	Type	Description
completedSections	[String!]!	Names of sections (e.g., "Education", "Personal") that are fully complete.
completionPercentage	Float!	Overall percentage of the profile that is complete.
missingSections	[String!]!	Names of sections that still require information.
nextRecommendedFields	[String!]!	Specific fields the user should fill next to increase their completion score.
scholarshipImpact	String!	A description of how completing the profile will improve scholarship matching.

ProviderStats

Financial statistics for a scholarship provider.

Field	Argument	Type	Description
scholarshipsAmount		Float	Total dollar amount of active scholarships offered by this provider.
totalAmountWon		Float	Total dollar amount awarded to students by this provider.

QuickApplyPayload

Result of a Quick Apply operation.

Field	Type	Description
application	Application	The full application object.
applicationId	ID	The ID of the newly created application.
created	Boolean!	Whether the application was successfully created.
scholarship	Scholarship	The scholarship object.
scholarshipId	ID!	The ID of the scholarship applied to.

RecommendedAction

A suggested action for the user to improve their experience or profile.

Field	Argument	Type	Description
action		String!	The name or key of the action.
priority		String!	Priority level of the action (e.g., "HIGH").

ReferencesQuery

Namespace for static reference data and geographic lookup services.

Field	Type	Description
dictionaries	AllDictionaries!	Retrieves a consolidated set of dictionary data (e.g., countries, states, degrees). This is the recommended way to load options for forms and filters.
filters	DictionaryFilters
ipData	IpData!	Provides geographic data based on the requester's current IP address.
zipData	ZipData!	Provides geographic details (city, state) for a given United States zip code.
zipCode	String!

RegistrationProgress

Tracking information for a multi-step registration or onboarding process.

Field	Type	Description
canSkipStep	Boolean!	Whether the current step can be bypassed by the user.
completedSteps	[String!]!	A list of steps that have been successfully completed.
completionPercentage	Float!	Overall percentage of the process that is complete.
currentStep	String!	The name or identifier of the user's current step.
isComplete	Boolean!	Whether the entire process has been completed.
lastUpdated	DateTime!	When the progress was last updated.
missingFields	[String!]!	A list of mandatory fields that are currently empty.
nextStep	String	The suggested next step for the user.
requiredFields	[String!]!	A list of field names that must be filled in for the current process.
totalCount	Int!	The total number of steps in the process.

ReportScholarshipOption

An option for reporting a scholarship (e.g., "Inappropriate content"). Used to populate the report modal in the UI.

Field	Type	Description
description	String!	Guidance text explaining what this report reason covers.
id	ID!	Unique identifier for the report option.
isActive	Boolean!	Whether this report option is currently enabled for use.
isAllowDetails	Boolean!	Whether the user is allowed to provide additional written details for this option.
orderNumber	Int!	Display order for the option in lists.
title	String!	Human-readable title for the report reason.

RequirementFile

A requirement for a file upload.

Field	Type	Description
allowedExtensions	[String!]	A list of allowed file extensions (e.g., "pdf", "docx").
createdAt	DateTime!
description	String
fileType	String	The specific type of file expected (e.g., "TRANSCRIPT").
id	ID!
isOptional	Boolean!
maxFileSize	Int	The maximum allowed file size in bytes.
name	String!
permanentTag	String
title	String
type	RequirementTypeEnum!
updatedAt	DateTime

RequirementGoal

A requirement for selecting a career or educational goal.

Field	Type	Description
createdAt	DateTime!
description	String
id	ID!
isOptional	Boolean!
name	String!
permanentTag	String
requiresDescription	Boolean	Whether the student must also provide a written description for their goal.
title	String
type	RequirementTypeEnum!
updatedAt	DateTime

RequirementImage

A requirement for an image upload.

Field	Type	Description
allowedFormats	[String!]	A list of allowed image formats (e.g., "jpg", "png").
createdAt	DateTime!
description	String
id	ID!
isOptional	Boolean!
maxFileSize	Int	The maximum allowed file size in bytes.
minHeight	Int	The minimum required height of the image in pixels.
minWidth	Int	The minimum required width of the image in pixels.
name	String!
permanentTag	String
title	String
type	RequirementTypeEnum!
updatedAt	DateTime

RequirementInput

A simple input requirement for a single piece of information.

Field	Type	Description
config	String	Configuration or validation rules for the input field.
createdAt	DateTime!
description	String
id	ID!
isOptional	Boolean!
name	String!
permanentTag	String
title	String
type	RequirementTypeEnum!
updatedAt	DateTime
value	String	The default or current value of the input.

RequirementMapEntry

A link between a required task and the student's submission for it.

Field	Argument	Type	Description
applicationRequirement		ApplicationRequirement	The student's actual response or file for this requirement.
requirement		Requirement!	The definition of what is required (e.g., "Write a 500-word essay").

RequirementSpecialEligibility

A requirement confirming a student's special eligibility status.

Field	Type	Description
createdAt	DateTime!
description	String
id	ID!
isOptional	Boolean!
name	String!
permanentTag	String
specialEligibilityType	String	The type of special eligibility being verified.
specialEligibilityValue	String	The value or threshold for verification.
title	String
type	RequirementTypeEnum!
updatedAt	DateTime

RequirementStats

Counter statistics for scholarship requirements.

Field	Type	Description
completed	Int!	Number of requirements successfully completed.
optional	Int!	Number of optional requirements.
total	Int!	Total number of requirements.

RequirementSurvey

A survey requirement consisting of multiple questions.

Field	Type	Description
createdAt	DateTime!
description	String
id	ID!
isOptional	Boolean!
name	String!
permanentTag	String
questions	[SurveyQuestion!]!	The list of questions the student must answer.
surveyType	String	The internal type or format of the survey.
title	String
type	RequirementTypeEnum!
updatedAt	DateTime

RequirementText

A text-based requirement, typically an essay or personal statement.

Field	Type	Description
allowFile	Boolean	Whether the student is allowed to upload a file instead of typing the text.
attachmentFormat	String	The allowed file format if the text is uploaded as a file.
attachmentType	String	The format for attachments, if applicable.
createdAt	DateTime!
description	String
essayTopics	[String!]!	Suggested topics or prompts for the essay. These can be used to guide AI generation or student writing.
id	ID!
isOptional	Boolean!
maxCharacters	Int	The maximum number of characters allowed.
maxWords	Int	The maximum number of words allowed.
minCharacters	Int	The minimum number of characters required.
minWords	Int	The minimum number of words required.
name	String!
permanentTag	String
sendType	String	The method by which the text is submitted (e.g., "plain_text").
title	String
type	RequirementTypeEnum!
updatedAt	DateTime

Scholarship

A scholarship opportunity available to students. Contains details about award amount, deadlines, requirements, and eligibility.

Field	Type	Description
amount	Float!	Award amount in USD. If multiple awards are available, this is typically the maximum amount.
applicationCount	Int	The total number of applications submitted for this scholarship.
applicationRequirementCounters	RequirementStats	Statistics about how many requirements have been completed by the current user.
applicationUrl	String	The URL to the external application page, if applicable.
categories	[ScholarshipCategory!]!	List of categories this scholarship belongs to.
category	String	Primary category name for the scholarship.
credibilityLevel	CredibilityLevel	A qualitative level of credibility (e.g., VERIFIED, HIGH).
credibilityScore	Float	A numerical score indicating the trustworthiness and quality of the scholarship.
deadline	DateTime!	The date and time when the scholarship application closes.
description	String	A detailed description of the scholarship, including its purpose and history.
eligibilities	[Eligibility!]!	Detailed eligibility criteria that a student must meet to qualify.
expirationDate	DateTime!	The date when the scholarship listing expires and is no longer visible to new applicants.
externalScholarshipId	String	An optional external reference ID for cross-referencing with other systems.
id	ID!	Unique identifier for the scholarship.
isActive	Boolean	Whether the scholarship is currently active and accepting applications.
isPublished	Boolean	Whether the scholarship is currently published and visible to users.
isSponsored	Boolean	Whether this is a sponsored scholarship, often appearing higher in search results.
myApplication	Application	The current user's application for this scholarship, if one exists.
payoutMethod	PayoutMethod	The method by which the award is paid out (e.g., directly to the college).
provider	ScholarshipProvider	Information about the organization providing the scholarship.
requirementCounters	RequirementStats	Statistics about the requirements for this scholarship.
requirements	[Requirement!]!	List of specific requirements (essays, files, etc.) needed to apply for this scholarship.
shortDescription	String	A brief summary of the scholarship for list views and cards.
startDate	DateTime	The date and time when the scholarship application opens for submissions.
status	ScholarshipStatus!	Current operational status of the scholarship (e.g., PUBLISHED, EXPIRED).
tags	[String!]!	A list of tags associated with the scholarship for categorization and search.
termsOfServiceUrl	String	URL to the official terms of service for this specific scholarship.
timezone	String	The timezone used for calculating deadlines and start dates.
title	String!	The title or name of the scholarship.
viewer	ScholarshipViewer	Contextual information for the current user regarding this scholarship.
winnerAnnouncementDate	DateTime	The date when winners are expected to be announced.
winners	[Winner!]!	Past and current winners of this scholarship.

ScholarshipCategory

Scholarship category used for grouping and organizational purposes.

Field	Type	Description
color	String	Hex color code or CSS class name used for UI representation.
description	String	Brief description of what this category covers.
id	ID!	Unique identifier for the category.
name	String!	Display name of the category.

ScholarshipConnection

A paginated list of scholarship records.

Field	Type	Description
nodes	[Scholarship!]!	The list of scholarship objects for the current page.
pageInfo	PageInfo!	Metadata for handling pagination (e.g., next page cursor).
totalCount	Int!	The total number of scholarships matching the filters across all pages.

ScholarshipProvider

Details about the organization or entity providing the scholarship.

Field	Type	Description
description	String	Detailed information about the organization.
id	ID!	Unique identifier for the provider.
logoUrl	String	URL to the provider's logo image.
mission	String	Mission statement of the organization.
name	String!	Legal or public name of the provider.
socials	ScholarshipProviderSocials	Social media links for the provider.
website	String	Official website URL of the provider.

ScholarshipProviderSocials

Social media profiles for a scholarship provider.

Field	Type	Description
facebook	String	Facebook page URL.
instagram	String	Instagram profile URL.
linkedin	String	LinkedIn profile or company page URL.
x	String	X (formerly Twitter) profile URL.

ScholarshipStats

Aggregated scholarship statistics for the current user.

Field	Type	Description
applicationCount	Int	Total number of applications the user has started or submitted.
applicationNotSeenCount	Int	Number of applications with updates or status changes the user hasn't seen.
easyApplyCount	Int	Number of "Easy Apply" scholarships the user is eligible for.
easyApplyNotSeenCount	Int	Number of "Easy Apply" scholarships the user has not yet viewed.
eligibleAmount	Float	The total potential award amount from all eligible scholarships.
eligibleCount	Int	Total number of scholarships the user is eligible for.
eligibleNotSeenCount	Int	Number of eligible scholarships the user has not yet viewed.
ignoredCount	Int	Number of scholarships the user has chosen to ignore.
recommendedCount	Int	Number of scholarships recommended for the user.
recommendedNotSeenCount	Int	Number of recommended scholarships the user has not yet viewed.
savedCount	Int	Number of scholarships the user has saved.
startedCount	Int	Number of applications the user has started but not yet submitted.

ScholarshipViewer

Contextual information for the current user (viewer) regarding a specific scholarship. Used to render UI states like "Saved", "Applied", or "Eligible".

Field	Type	Description
allMandatoryRequirementsCompleted	Boolean	Whether the user has provided all mandatory requirement responses.
applicationPreviewData	ApplicationPreviewData	Application preview data used to render the "review application" modal. This contains a summary of the user's responses and the scholarship's expectations.
favoriteAt	DateTime	The timestamp when the scholarship was favorited by the user.
hasApplication	Boolean!	Whether the user has an application record (even if incomplete) for this scholarship.
hasSubmitted	Boolean!	Whether the user has successfully submitted their application.
ignoredAt	DateTime	The timestamp when the scholarship was ignored by the user.
isEligible	Boolean!	Whether the current user meets all mandatory eligibility criteria.
isFavorite	Boolean!	Whether the user has marked this scholarship as a favorite.
isIgnored	Boolean!	Whether the user has chosen to ignore/hide this scholarship.
isRecommended	Boolean!	Whether this scholarship is recommended for the current user based on their profile.
isSaved	Boolean!	Whether the user has saved this scholarship for later.
reportedAt	DateTime	The timestamp when the user reported this scholarship.
requirementCount	Int	The total number of requirements the user needs to complete for this scholarship.

ScholarshipsMutations

Namespaced mutation surface for modifying scholarship-related data and applications.

Field	Type	Description
apply	Boolean!	Initializes an application for a scholarship.
scholarshipId	ID!
subSource	String
deleteApplicationRequirement	Boolean!	Removes a previously submitted response for a requirement.
id	ID!
type	RequirementTypeEnum!
generateEssay	EssayGenerationResult!	Uses AI to generate an initial draft for a text/essay requirement based on a topic.
input	GenerateEssayInput!
generateEssayDiff	EssayDiffResult!	Saves the differences between AI-generated text and user-edited text for analytics.
input	GenerateEssayDiffInput!
markSeen	Boolean!	Marks a list of scholarships as "seen" by the user to update unread counters.
scholarshipIds	[ID!]!
quickApply	QuickApplyPayload!	Performs a "Quick Apply" operation using a previously saved requirement response.
input	QuickApplyInput!
report	Boolean!	Reports a scholarship for a specific reason with optional details.
details	String
id	ID!
reason	ReportReason!
reportWithOption	Boolean!	Reports a scholarship using a predefined option ID from `reportOptions`.
details	String
optionId	ID!
scholarshipId	ID!
submitApplicationRequirement	ApplicationRequirement!	Saves or updates a response for a specific scholarship requirement (e.g., uploading an essay).
input	ApplicationRequirementInput!
updateStatus	Boolean!	Updates the user's status for a scholarship (e.g., Save, Ignore).
action	ScholarshipAction!
scholarshipId	ID!

ScholarshipsQuery

Namespaced query surface for all scholarship-related operations.

Field	Type	Description
automaticScholarships	[AutomaticScholarship!]!	Retrieves a list of scholarships that are automatically applied for on behalf of the user.
byId	Scholarship	Retrieves detailed information for a single scholarship by its ID.
id	ID!
list	ScholarshipConnection!	Searches and lists scholarships based on filters, pagination, and sorting. This is the primary way to discover opportunities.
filters	ScholarshipFilters
pagination	PaginationInput
sort	[SortInput!]
reportOptions	[ReportScholarshipOption!]!	Retrieves a list of valid reasons/options for reporting a scholarship.
winners	WinnerConnection!	Retrieves a paginated list of scholarship winners.
input	WinnersInput

SchoolLevel

Educational levels available for user selection.

Field	Argument	Type	Description
description		String
id		ID!
isActive		Boolean!
name		String!
order		Int
value		String!

SetPasswordResult

The result of a password setup operation.

Field	Type	Description
account	Account	The updated account object.
message	String	A status or error message.
success	Boolean!	Whether the password was successfully set.

SocialAccount

A link between a platform account and a third-party social profile.

Field	Type	Description
connectedAt	DateTime!	When the social account was first connected.
email	String	The email address associated with the social profile.
id	ID!	Unique identifier for the social link.
name	String	The name displayed on the social profile.
provider	SocialProvider!	The social identity provider.
providerId	String!	The external ID provided by the social platform.

State

Geographic state or province information.

Field	Type	Description
code	String!	The standard postal abbreviation for the state.
country	String	The country the state belongs to.
id	ID!
isActive	Boolean!
name	String!	The full name of the state.
order	Int

StateConnection

A paginated collection of state options.

Field	Argument	Type	Description
edges		[StateEdge!]!
pageInfo		PageInfo!
totalCount		Int!

StateEdge

Field	Argument	Type	Description
cursor		String!
node		State!

SuccessResponse

A generic response structure for simple success/failure operations.

Field	Type	Description
data	JSON	Optional result data associated with the operation.
message	String	An optional status or informational message.
success	Boolean!	Whether the operation was successful.

SurveyQuestion

A single question within a survey requirement.

Field	Type	Description
id	String!	Unique identifier for the question.
options	[SurveyQuestionOption!]	A list of predefined options for selection-based questions.
required	Boolean!	Whether an answer is mandatory for this specific question.
text	String!	The text of the question.
type	SurveyQuestionType!	The type of input expected for the answer (e.g., RADIO, CHECKBOX).

SurveyQuestionOption

A predefined option for a selection-based survey question.

Field	Argument	Type	Description
label		String!	The human-readable label displayed to the student.
value		String!	The machine-readable value of the option.

UserCreationResult

The result of a user registration attempt.

Field	Type	Description
eligibleScholarshipsCount	Int!	The number of scholarships the user is already eligible for based on their registration data.
errors	[UserError!]	A list of validation or processing errors that occurred.
expiresAt	DateTime	The expiration timestamp for the authentication token.
nextRecommendedActions	[RecommendedAction!]!	Suggested steps for the user to take after registration (e.g., "Verify Email").
profileProgress	ProfileProgress!	An assessment of how much of the user's profile is complete.
sessionAuthentication	Boolean	Internal flag indicating if the session was automatically authenticated.
success	Boolean!	Whether the user account was successfully created.
token	String	Authentication token for the new user session.
user	Account	The newly created account details.
warnings	[String!]	Informational warnings that did not prevent account creation.

UserError

Detailed information about a validation or processing error.

Field	Type	Description
code	String	A stable error code for programmatic handling.
field	String	The name of the input field associated with the error, if any.
message	String!	A human-readable error message.

UserUpdateResult

The result of an account update operation.

Field	Type	Description
errors	[UserError!]	A list of validation or processing errors.
profileProgress	ProfileProgress	The updated assessment of profile completion.
success	Boolean!	Whether the update was successful.
updatedFields	[String!]	A list of field names that were successfully updated.
user	Account	The updated account details.

Viewer

The calling context (viewer) for the current request. This namespace groups all operations and data related to the currently authenticated user.

Field	Type	Description
account	Account	The current authenticated user account and profile. Returns null if the request is not authenticated.
applications	ApplicationConnection!	A list of scholarship applications submitted by or in-progress for the current user.
filters	ApplicationFilters
pagination	PaginationInput
onboarding	ViewerOnboarding!	Status and management of the onboarding process for the current user.
stats	ViewerStats!	Aggregated statistics and counters for the current user's activity.

ViewerMutations

Mutations specific to the currently authenticated user's profile and session.

Field	Type	Description
onboarding	ViewerOnboardingMutations!	Operations related to the user's onboarding process.
postEligibility	PostEligibilityResult!	Perform a quick eligibility assessment without requiring a full account. Used in landing pages and marketing funnels.
input	PostEligibilityInput!
updateUser	UserUpdateResult!	Updates the profile and account settings for the currently authenticated user.
input	UpdateUserInput!

ViewerOnboarding

Management of the user's initial setup and onboarding experience.

Field	Type	Description
plugins	[OnboardingPlugin!]!	A list of available third-party offers or integrations (plugins) the user can engage with.
registrationCompletedAt	DateTime	The timestamp when the user completed their initial registration.
registrationProgress	RegistrationProgress!	Progress tracking for the multi-step registration flow.
registrationSource	RegistrationSource	The channel or campaign through which the user first joined.

ViewerOnboardingMutations

Mutations for managing onboarding state and plugin interactions.

Field	Argument	Type	Description
submitPlugins		[OnboardingPluginSubmissionResult!]!	Submits user choices or data for one or more onboarding plugins.
input		[OnboardingPluginSubmissionInput!]!

ViewerStats

Aggregated statistics for the current authenticated user.

Field	Argument	Type	Description
scholarships		ScholarshipStats!	Summary of scholarship-related metrics (e.g., number of eligible, saved, or new scholarships).

Winner

Information about a student who won a scholarship. Includes their profile details and any testimonial they provided.

Field	Type	Description
amountWon	String	The amount of money awarded to this specific winner.
id	ID!	Unique identifier for the winner record.
major	String	The winner's academic major or field of study.
name	String	The display name of the winner.
photoUrl	String	URL to a photo of the winner.
scholarship	Scholarship	The scholarship that was won.
scholarshipTitle	String	The title of the scholarship at the time it was won.
school	String	The school or university the winner attends.
story	String	The winner's personal story or experience with the scholarship.
testimonialText	String	The written testimonial provided by the winner.
testimonialVideo	String	URL to a video testimonial provided by the winner.
winnerPhoto	String	URL to a photo provided by the winner specifically for the testimonial.
wonAt	String	The date when the scholarship was awarded.
year	Int	The graduation year of the winner.

WinnerConnection

A paginated collection of scholarship winners.

Field	Type	Description
nodes	[Winner!]!	List of winner records for the current page.
pageInfo	PageInfo!	Pagination metadata.
totalCount	Int!	Total number of winners matching the criteria.

ZipData

Geographic information associated with a specific zip code.

Field	Argument	Type	Description
city		String	The name of the city.
state		ZipState	The state the zip code belongs to.

ZipState

Details of a geographic state linked to a zip code.

Field	Type	Description
abbreviation	String!	The standard two-letter state abbreviation.
id	ID!	Unique identifier for the state.
name	String!	The full name of the state.

Inputs

AccountRegistrationInput

Comprehensive input for account registration, including profile details.

Field	Type	Description
acceptTerms	Boolean!
address	AddressInput
careerGoal	String
dateOfBirth	DateTime
education	[EducationInput!]
email	String!
ethnicity	String
firstName	String!
hobbies	[String!]
lastName	String!
militaryAffiliation	String
phone	String
recaptchaToken	String!
socialProvider	SocialProvider	The social identity provider used for registration.
socialToken	String	The authentication token from the social provider.

AccountUpdateInput

Input for updating the current user's profile and account settings.

Field		Type	Description
address		AddressInput
careerGoal		String
dateOfBirth		DateTime
education		[EducationInput!]
ethnicity		String
firstName		String
hobbies		[String!]
lastName		String
militaryAffiliation		String
phone		String

AddressInput

Physical address details.

Field		Type	Description
city		String
country		String
state		String
street		String
zipCode		String

ApplicationFileInput

Input for creating or updating a file upload response.

Field		Type	Description
fileBase64		String!
fileName		String!
id		ID
requirementId		ID!
scholarshipId		ID!

ApplicationFilters

Filtering options for querying scholarship applications.

Field	Type	Description
scholarshipId	ID	Filter by a specific scholarship ID.
status	[ApplicationStatus!]	Filter by one or more application statuses.
submittedAfter	DateTime	Filter applications submitted after this date.
submittedBefore	DateTime	Filter applications submitted before this date.

ApplicationGoalInput

Input for creating or updating a goal selection response.

Field		Type	Description
description		String
id		ID
requirementId		ID!
scholarshipId		ID!

ApplicationImageInput

Input for creating or updating an image upload response.

Field		Type	Description
fileBase64		String!
fileName		String!
id		ID
requirementId		ID!
scholarshipId		ID!

ApplicationInputInput

Input for creating or updating a simple input requirement response.

Field		Type	Description
id		ID
requirementId		ID!
scholarshipId		ID!
text		String!

ApplicationRequirementInput

Unified input for submitting or updating any type of requirement response. Ensure only the fields relevant to the type are provided.

Field	Type	Description
accountFileId	ID	ID of an already uploaded file to reuse for this response.
answers	JSON	Answer set for SURVEY types, provided as a JSON object mapping question IDs to values.
fileBase64	String	Base64-encoded file content for FILE and IMAGE types.
fileName	String	Name of the file being uploaded for FILE and IMAGE types.
goalValue	String	Selection value for GOAL types.
id	ID	The ID of the existing response if performing an update.
requirementId	ID!	The ID of the requirement definition being fulfilled.
scholarshipId	ID!	The ID of the scholarship the requirement belongs to.
specialEligibilityValue	String	Verification value for SPECIAL_ELIGIBILITY types.
text	String	Written content for TEXT and INPUT types.
type	RequirementTypeEnum!	The type of requirement being submitted.

ApplicationSpecialEligibilityInput

Input for creating or updating a special eligibility response.

Field		Type	Description
id		ID
requirementId		ID!
scholarshipId		ID!
specialEligibilityValue		String!

ApplicationSurveyInput

Input for creating or updating a survey requirement response.

Field		Type	Description
answers		JSON!
id		ID
requirementId		ID!
scholarshipId		ID!

ApplicationTextInput

Input for creating or updating a text-based requirement response. (Consider using the unified ApplicationRequirementInput instead).

Field		Type	Description
accountFileId		ID
extra		JSON
fileBase64		String
fileName		String
id		ID
requirementId		ID!
scholarshipId		ID!
text		String

BillingSubscriptionCancellationSurveyInput

Input for submitting a subscription cancellation reason.

Field	Type	Description
details	String	Additional details or feedback from the user.
optionId	ID!	The ID of the selected cancellation reason option.
subscriptionId	ID!	The ID of the subscription being canceled.

ConnectSocialAccountInput

Input for linking a third-party social account.

Field	Type	Description
profile	JSON	Optional profile information from the provider.
provider	String!	The social provider name (e.g., "google").
token	String!	The identity token from the provider.

CreateUserInput

Comprehensive input for creating a new user, typically used in a registration flow.

Field	Type	Description
acceptedMarketing	Boolean	Indicates whether the user wants to receive marketing communications.
acceptedPrivacy	Boolean	Must be true to indicate agreement with the privacy policy.
acceptedTerms	Boolean	Must be true to indicate agreement with the terms of service.
address	UserAddressInput	Physical mailing address.
autoApplyConsent	Boolean	Indicates whether the user consents to being automatically applied for certain scholarships.
careerGoal	String
citizenship	String
dateOfBirth	DateTime
education	RegistrationEducationInput	Initial education details.
email	String!	The unique email address for the new account.
ethnicity	String
firstName	String
gender	String	User's gender identity.
lastName	String
militaryAffiliation	String
password	String	The account password.
phone	String
recaptchaToken	String	A valid reCAPTCHA token for bot prevention.
registrationSource	String	Internal identifier for the registration channel or campaign.
utmParams	JSON	Marketing tracking parameters (e.g., utm_source, utm_medium).

DateRangeInput

Input for filtering results within a specific date and time range.

Field		Type	Description
from		DateTime	The start of the range (inclusive).
to		DateTime	The end of the range (inclusive).

DictionaryFilters

Filtering options for dictionary queries.

Field	Type	Description
category	String	Filter items by a specific category.
country	String	Filter items by country code.
isActive	Boolean	Whether to return only active items.
search	String	Search term to match against names or descriptions.
state	String	Filter items by state code.

EducationInput

Education history entry.

Field	Type	Description
degree	String	Degree being pursued or attained (e.g., "Bachelor of Arts").
fieldOfStudy	String	Academic major or field of study.
gpa	Float	Current Grade Point Average.
graduationDate	DateTime	Expected or actual graduation date.
schoolLevel	String!	Current level of education (e.g., "High School", "Undergraduate").
schoolName	String!	Name of the school or institution.

FloatRangeFilter

Filter for a range of floating-point values.

Field		Type	Description
max		Float
min		Float

GenerateEssayDiffInput

Input parameters for saving an essay diff.

Field	Type	Description
aiGeneratedText	String!	The original text generated by the AI.
requirementId	ID!	The ID of the requirement.
userEditedText	String!	The final text after user edits.

GenerateEssayInput

Input parameters for AI essay generation.

Field	Type	Description
requirementId	ID!	The ID of the requirement the essay is for.
topic	String!	The selected topic or prompt for the essay.
userInput	String	Optional additional context or notes from the user to guide the AI.

GoogleAuthInput

Input for authenticating via Google OAuth.

Field	Type	Description
action	GoogleAuthAction!	The action being performed (LOGIN or SIGNUP).
code	String!	The authorization code returned by the Google identity provider.
redirectUri	String!	The URI Google should redirect to after authentication.
remember	Boolean	Whether to extend the session duration.

IntRangeFilter

Filter for a range of integer values.

Field		Type	Description
max		Int
min		Int

LoginInput

Input for authenticating with email and password.

Field	Type	Description
email	String!
password	String!
remember	Boolean	Whether to extend the session duration.

OnboardingPluginSubmissionInput

Input for submitting data for an onboarding plugin.

Field		Type	Description
extra		JSON	The user-provided data or selections for the plugin.
id		ID!	The ID of the plugin being submitted.

PaginationInput

Input for cursor-based forward pagination.

Field		Type	Description
after		String	The cursor after which to start returning results.
first		Int	The number of items to return in the page (defaults to 20).

PasswordChangeInput

Input for changing the current user's password.

Field	Type	Description
currentPassword	String!	The user's current password.
newPassword	String!	The new password to set.
retypePassword	String!	Confirmation of the new password.

PasswordResetInput

Input for requesting a password reset email.

Field		Type	Description
email		String!	The email address associated with the account.

PostEligibilityInput

Input for a lightweight eligibility check, typically used before full registration.

Field		Type	Description
degreeType		String!	The type of degree the user is pursuing or planning to pursue.
dob		String!	The user's date of birth string.

ProfileUpdateInput

Input for updating general profile information.

Field		Type	Description
address		AddressInput
careerGoal		String
dateOfBirth		DateTime
education		[EducationInput!]
ethnicity		String
firstName		String
hobbies		[String!]
lastName		String
militaryAffiliation		String
phone		String

QuickApplyInput

Input parameters for performing a Quick Apply.

Field		Type	Description
answerId		String!	The ID of a previously submitted answer or file to reuse for this application.
scholarshipId		ID!	The ID of the scholarship to apply for.

RegisterAccountInput

Input for registering a basic account.

Field	Type	Description
acceptTerms	Boolean	Must be true to indicate agreement with the platform's terms of service.
email	String!
firstName	String!
lastName	String!
password	String!
recaptchaToken	String	A valid reCAPTCHA token for bot prevention.

RegistrationEducationInput

Education details collected during or after registration.

Field	Type	Description
collegeName	String	Name of the college or university attending or planning to attend.
degree	String	The degree being pursued (e.g., "Bachelor's").
fieldOfStudy	String	Academic major or field of study.
gpa	Float	Current Grade Point Average.
highSchoolGraduation	DateTime	Date of high school graduation.
highSchoolName	String	Name of the high school attended.
schoolLevel	String	Current educational level (e.g., "High School Senior").

ResetPasswordInput

Input for resetting a password using a verification token.

Field	Type	Description
email	String!	The user's email address.
password	String!	The new password to set.
retypePassword	String!	Confirmation of the new password.
token	String!	The verification token received via email.

ScholarshipFilters

Comprehensive filtering options for searching scholarships. Allows for precise matching based on profile, interests, and status.

Field	Type	Description
age	IntRangeFilter	Filter by age range.
categories	[String!]	Filter by scholarship category IDs.
credibilityLevel	[CredibilityLevel!]	Filter by specific credibility levels.
deadlineAfter	DateTime	Filter for scholarships with a deadline after this date.
deadlineBefore	DateTime	Filter for scholarships with a deadline before this date.
degree	[String!]	Filter by degrees being pursued.
ethnicity	[String!]	Filter by ethnicity requirements.
expirationAfter	DateTime	Filter for scholarships with an expiration date after this date.
expirationBefore	DateTime	Filter for scholarships with an expiration date before this date.
fieldOfStudy	[String!]	Filter by academic fields of study.
gender	[String!]	Filter by gender requirements.
gpa	FloatRangeFilter	Filter by GPA range.
hasApplication	Boolean	If true, returns scholarships that have an associated application record for the user.
isActive	Boolean	If true, returns only active scholarships.
isEasyApply	Boolean	If true, returns "Easy Apply" scholarships that require minimal effort to submit.
isEligible	Boolean	If true, returns only scholarships the current user is eligible for.
isFavorite	Boolean	If true, returns scholarships the user has marked as favorites.
isIgnored	Boolean	If true, returns scholarships the user has chosen to ignore.
isInstant	Boolean	If true, returns scholarships that are marked as "Instant" opportunities.
isRecommended	Boolean	If true, returns scholarships recommended for the user by the platform's engine.
isReported	Boolean	If true, returns scholarships the user has reported.
isSaved	Boolean	If true, returns scholarships the user has saved.
isStarted	Boolean	If true, returns scholarships where the user has started but not finished an application.
isSubmitted	Boolean	If true, returns scholarships where the user has submitted an application.
maxAmount	Float	Maximum award amount in USD.
maxApplicants	Int	Maximum number of applicants allowed before a scholarship is filtered out (if applicable).
maxRequirements	Int	Maximum number of requirements a scholarship can have. Useful for finding low-effort opportunities.
militaryAffiliation	[String!]	Filter by military affiliation requirements.
minAmount	Float	Minimum award amount in USD.
minCredibilityScore	Float	Minimum threshold for the scholarship's credibility score.
organizationId	[ID!]	Filter by provider organization IDs.
requirementTypes	[RequirementTypeEnum!]	Filter by the types of requirements present (e.g., Essay, File Upload).
schoolLevel	[String!]	Filter by educational levels (e.g., "High School Senior").
search	String	Text search query to match against titles, descriptions, and tags.
state	[String!]	Filter by geographic state requirements.
status	[ScholarshipStatus!]	Filter by current scholarship status.

ScholarshipSort

Configuration for sorting scholarship results.

Field		Type	Description
direction		SortDirection!	The direction to sort in (ASC or DESC).
field		ScholarshipSortField!	The field to sort by.

SearchInput

Input for performing text search operations.

Field	Type	Description
fields	[String!]	Optional list of specific fields to search within.
fuzzy	Boolean	Whether to use fuzzy matching for the search query.
query	String!	The search query string.

SetPasswordInput

Input for setting a password on an existing account (e.g., during multi-step registration).

Field		Type	Description
accountId		ID!	The ID of the account to update.
password		String!	The new password.

SocialLoginInput

Input for authenticating via a social provider.

Field	Type	Description
acceptTerms	Boolean!	Agreement to terms and conditions.
provider	SocialProvider!	The social provider (e.g., GOOGLE, FACEBOOK).
token	String!	The identity token provided by the social platform.

SortInput

Input for sorting a list of results.

Field		Type	Description
direction		SortDirection!	The direction in which to sort (ASC or DESC).
field		String!	The name of the field to sort by.

UpdateUserInput

Input for updating the profile fields of the current user.

Field	Type	Description
acceptedMarketing	Boolean
acceptedPrivacy	Boolean
acceptedTerms	Boolean
address	UserAddressInput
autoApplyConsent	Boolean
careerGoal	String
citizenship	String
currentPassword	String	The user's current password, required for sensitive changes like updating email or password.
dateOfBirth	DateTime
education	RegistrationEducationInput
email	String
ethnicity	String
firstName	String
gender	String
lastName	String
militaryAffiliation	String
newPassword	String	The new password to set.
password	String	Updates the account password.
passwordConfirmation	String	Verification of the new password.
phone	String

UserAddressInput

Physical address details for a user.

Field		Type	Description
city		String
country		String
state		String
street		String
zipCode		String

WinnersInput

Input for querying scholarship winners.

Field	Type	Description
externalScholarshipTemplateId	String	Filter winners by a specific scholarship template ID.
pagination	PaginationInput	Pagination settings.
sort	String	Sort order for the winners list (e.g., "-wonAt").

Enums

ApplicationStatus

The various states an application can transition through.

Value	Description
ACCEPTED	The user has been selected as a winner or their application was accepted.
ELIGIBLE	The user is eligible for the scholarship but has not yet started an application.
INCOMPLETE	The application is missing one or more mandatory requirement responses.
IN_PROGRESS	The user is actively working on the application requirements.
PENDING_REVIEW	The application is awaiting evaluation by the scholarship provider.
READY_TO_SUBMIT	All mandatory requirements are met; the application is ready for final submission.
REJECTED	The user was not selected for this scholarship.
SAVED	The user has saved the scholarship for later.
SENT	The application has been successfully transmitted to the provider.
STARTED	The user has initiated the application process.
SUBMITTED	The application has been submitted by the user.

CredibilityLevel

Qualitative assessment of a scholarship's trustworthiness.

Value	Description
HIGH	High level of trust based on historical performance and provider reputation.
LOW	New or unverified scholarship; users should proceed with caution.
MEDIUM	Standard scholarship with no significant red flags.
VERIFIED	The scholarship and provider have been manually verified by the platform team.

DictionaryType

The categories of dictionary data available on the platform.

Value	Description
CAREER_GOAL
CITIZENSHIP
DEGREE
DEGREE_TYPE
ETHNICITY
GENDER
HIGH_SCHOOL
MILITARY_AFFILIATION
SCHOOL_LEVEL
STATE

EligibilityOperator

Logical operators used to evaluate eligibility criteria.

Value	Description
EQUALS
GREATER_THAN
GREATER_THAN_OR_EQUAL
IN
LESS_THAN
LESS_THAN_OR_EQUAL
NOT_IN

EligibilityType

The category of data used to determine eligibility.

Value	Description
AGE	Age-based restrictions.
CUSTOM	A custom criterion not covered by standard types.
DEGREE	The specific degree being pursued (e.g., Bachelor of Science).
ETHNICITY	Ethnicity or race-based requirements.
FIELD_OF_STUDY	The specific academic major or field of study.
GENDER	Gender-specific scholarship requirements.
GPA	Grade Point Average requirements.
MILITARY_AFFILIATION	Requirements related to military service or affiliation.
SCHOOL_LEVEL	Current educational level (e.g., High School Senior, College Junior).
STATE	Geographic residency requirements (usually state-level).

GoogleAuthAction

The type of authentication action to perform via Google.

Value	Description
LOGIN	Authenticate an existing user.
SIGNUP	Register a new user.

PayoutMethod

The method used to deliver funds to the scholarship winner.

Value	Description
COLLEGE	Funds are sent directly to the student's educational institution.
NON_MONETARY_AWARDS	The award consists of products, services, or other non-cash benefits.
NOT_STATED	The payout method has not been specified by the provider.
STUDENT	Funds are sent directly to the student via check, ACH, or other means.

RegistrationSource

The original source or channel through which a user registered.

Value	Description
DIRECT	Registered directly via the platform's signup form.
INVITATION	Registered via an invitation from another user.
SOCIAL_LOGIN	Registered using a social media account.
THIRD_PARTY	Registered through an external partner or integration.

ReportReason

The primary reason for reporting a scholarship listing.

Value	Description
BROKEN_LINK	The application URL or provider website link is no longer functional.
INAPPROPRIATE	The listing contains offensive or inappropriate language/images.
MISLEADING	The scholarship details or provider information is false or misleading.
OTHER	Another reason not covered by standard options.
SPAM	The content appears to be unwanted spam or promotional material.

RequirementTypeEnum

The available types of scholarship requirements.

Value	Description
FILE	A general file upload (e.g., PDF, DOCX).
GOAL	Selection of educational or career goals.
IMAGE	An image file upload (e.g., JPG, PNG).
INPUT	A single text input field.
SPECIAL_ELIGIBILITY	Special criteria that must be confirmed by the student.
SURVEY	A set of survey questions.
TEXT	A written response or essay.

ScholarshipAction

The action to perform when updating the user's relationship with a scholarship.

Value	Description
FAVORITE	Mark the scholarship as a favorite.
IGNORE	Hide the scholarship from future search results and lists.
SAVE	Save the scholarship for later consideration.
UNFAVORITE	Remove the favorite status.
UNIGNORE	Stop ignoring the scholarship so it appears in results again.
UNSAVE	Remove the scholarship from the saved list.

ScholarshipSortField

Available fields for sorting scholarship lists.

Value	Description
AMOUNT	Sort by the total award amount.
APPLICATION_COUNT	Sort by the total number of applications received.
CREATED_AT	Sort by the date the scholarship was added to the platform.
CREDIBILITY_SCORE	Sort by the platform's credibility score.
DEADLINE	Sort by the application deadline date.
RELEVANCE	Sort by relevance to the search query or user profile.
TITLE	Sort alphabetically by the scholarship title.
UPDATED_AT	Sort by the date the scholarship listing was last updated.

ScholarshipStatus

The lifecycle status of a scholarship listing.

Value	Description
CANCELED	Canceled by the provider or platform administrators.
CANCELED_AND_EXPIRED	The scholarship was canceled and its deadline has also passed.
EXPIRED	The application deadline has passed.
PUBLISHED	Active and visible to students.
UNPROCESSABLE	The scholarship listing is in an invalid state and cannot be processed.
UNPUBLISHED	Hidden from search results but still exists in the system.

SchoolType

The type of educational institution.

Value	Description
COLLEGE
HIGH_SCHOOL
UNIVERSITY

SocialProvider

Available third-party identity providers for social authentication.

Value	Description
APPLE
FACEBOOK
GOOGLE
LINKEDIN

SortDirection

The direction of a sort operation.

Value	Description
ASC	Ascending order (e.g., A-Z, 0-9).
DESC	Descending order (e.g., Z-A, 9-0).

SurveyQuestionType

Input types for survey questions.

Value	Description
CHECKBOX	Multiple-choice selection using checkboxes.
RADIO	Single-choice selection using radio buttons.
SELECT	Single-choice selection using a dropdown menu.
TEXT	A single-line text input.
TEXTAREA	Multi-line text input for longer responses.

Scalars

Boolean

The Boolean scalar type represents true or false.

DateTime

The DateTime scalar type represents a Date and Time string in ISO 8601 format (e.g., "2023-12-25T12:00:00Z").

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

JSON

The JSON scalar type represents a JSON-compatible structure (object, array, string, number, or boolean).

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Upload

The Upload scalar type represents a file upload in a multi-part request.

Interfaces

ApplicationRequirement

Base interface for all student responses to scholarship requirements. These objects store the actual content or files provided by the student.

Field	Type	Description
createdAt	DateTime!	When the response was first created.
id	ID!	Unique identifier for the response.
source	String	The source of the response (e.g., manual entry, AI generated).
updatedAt	DateTime	When the response was last updated.

Possible Types: ApplicationFile, ApplicationGoal, ApplicationImage, ApplicationInput, ApplicationSpecialEligibility, ApplicationSurvey, ApplicationText

Requirement

Base interface for all scholarship requirements. Requirements define what a student must provide (e.g., an essay, a file, a survey) to apply for a scholarship.

Field	Type	Description
createdAt	DateTime!	Timestamp when the requirement was created.
description	String	Instructions or description for the student on how to fulfill the requirement.
id	ID!	Unique identifier for the requirement.
isOptional	Boolean!	Whether this requirement is optional or mandatory for application submission.
name	String!	Internal name for the requirement.
permanentTag	String	Stable identifier used for categorization and automated processing.
title	String	Public-facing title of the requirement (e.g., "Personal Statement").
type	RequirementTypeEnum!	The category of the requirement (e.g., TEXT, FILE, SURVEY).
updatedAt	DateTime	Timestamp when the requirement was last updated.

Possible Types: RequirementFile, RequirementGoal, RequirementImage, RequirementInput, RequirementSpecialEligibility, RequirementSurvey, RequirementText

Schema Types ​

Query ​

Mutation ​

Objects ​

Account ​

AccountFile ​

Address ​

AllDictionaries ​

Application ​

ApplicationConnection ​

ApplicationFile ​

ApplicationGoal ​

ApplicationImage ​

ApplicationInput ​

ApplicationPreviewApplicationData ​

ApplicationPreviewData ​

ApplicationPreviewField ​

ApplicationPreviewRequirements ​

ApplicationSpecialEligibility ​

ApplicationSurvey ​

ApplicationText ​

AuthMutations ​

AuthResponse ​

AutomaticScholarship ​

BillingMutations ​

BillingPackage ​

BillingPaymentPopupDetails ​

BillingQuery ​

BillingSpecialOfferPage ​

BillingSpecialOfferPageConnection ​

CareerGoal ​

CategoryStats ​

Degree ​

DegreeType ​

DictionaryItem ​

Document ​

Education ​

Eligibility ​

EligibilityField ​

EssayDiffResult ​

EssayGenerationResult ​

Ethnicity ​

EthnicityConnection ​

EthnicityEdge ​

GraphQLError ​

HighSchool ​

HighSchoolConnection ​

HighSchoolEdge ​

IpData ​

Membership ​

OnboardingPlugin ​

OnboardingPluginSubmissionResult ​

Package ​

PageInfo ​

PostEligibilityResult ​

ProfileCompletion ​

ProfileProgress ​

ProviderStats ​

QuickApplyPayload ​

RecommendedAction ​

ReferencesQuery ​

RegistrationProgress ​

ReportScholarshipOption ​

RequirementFile ​

RequirementGoal ​

RequirementImage ​

RequirementInput ​

RequirementMapEntry ​

RequirementSpecialEligibility ​

RequirementStats ​

RequirementSurvey ​

RequirementText ​

Scholarship ​

ScholarshipCategory ​

ScholarshipConnection ​

ScholarshipProvider ​

ScholarshipProviderSocials ​

ScholarshipStats ​

ScholarshipViewer ​

ScholarshipsMutations ​