Common Workflows

Here are the most common operations for consumers of the API.

1. Show Eligible Scholarships

Retrieve scholarships the current user is eligible for:

query Eligible($pagination: PaginationInput) {
  scholarships {
    list(filters: { isEligible: true }, pagination: $pagination) {
      totalCount
      nodes {
        id
        title
        amount
      }
    }
  }
}

2. Apply to a Scholarship

To apply, first create an application record:

mutation Apply($scholarshipId: ID!) {
  scholarships {
    apply(scholarshipId: $scholarshipId)
  }
}

3. Submit Requirements

After applying, you may need to submit specific requirements (essays, files, etc.):

mutation SubmitText($input: SubmitApplicationRequirementInput!) {
  submitApplicationRequirement(input: $input) {
    success
    applicationRequirement {
      id
      __typename
    }
  }
}