addFolder
Create a folder
input: object
addFormative
Create a new formative (assessment/lesson) owned by the authenticated user.
**Basic example:**
```json
{
"input": {
"title": "Math Quiz"
}
}
```
**With questions:**
```json
{
"input": {
"title": "Math…
input: object
addFormativeItem
Add a new item (question or content) to a formative. Requires ownership of the formative.
**Question Types and Configuration:**
**Multiple Choice** (type: "multipleChoice")
- choices: ["A", "B", "C", "D"] - Choice…
formativeId: string, subtype: string, input: object
addOneRoster
Create a new OneRoster import configuration
input: object
addOrg
Create a new organization
input: object
addOrgNote
Attach an internal note to an organization
input: object
addPracticeAnswer
Submit an answer for a practice item
input: object, practiceItemId: string
addPracticeItem
Add a practice item to a practice set
input: object, practiceSetId: string
addQuickLink
Create a quick link
input: object
addSection
Create a new section (class). Note: In Formative, "section" and "class" are interchangeable terms.
**Required:**
- title: Section name (cannot contain emails or URLs)
**Optional appearance:**
- abbreviation: Short…
input: object
addSectionCollaborators
Add collaborators to a section
input: object
addStudentEnrollments
Enroll students into a section
joinCode?, sectionId: string, userIds: array
addUser
Create a new user account.
**Identity:**
- firstName, lastName: User's name
- nickname: Display name (optional)
- emails: Array of email addresses (preferred for test users)
- username: Username for login (prefer…
input: object
addUserNote
Add an admin note to a user account. The note will be attributed to the authenticated user.
input: object
aiConfigurationsread-only
Fetch AI configurations filtered by grade, subject, and org
grades?, orgIds?, public: boolean, subjects?
aiThreadsread-only
List AI threads with associated messages and configuration
input?
answersread-only
Fetch answers with filters across assignments, sections, or students.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to…
after?, assignmentId?, assignments?, first: integer, formativeId?, formativeItemId?, formativeItems?, formatives?, … (list cut; the site may define more)
archiveStudentEnrollments
Archive student enrollments from a section
sectionId: string, userIds: array
assignPracticeSet
Assign a practice set to a section
practiceSetId: string, sectionId: string
createDemoSandbox
Create a complete demo environment with pre-populated data.
This is the fastest way to set up a testing environment with:
- Organizations (schools/districts)
- Teachers and students with login credentials
…
name: string
createOneRosterSftpAccount
Create SFTP account credentials for OneRoster uploads
rosterId: string
deleteQuickLink
Delete a quick link
id: string
editQuickLink
Edit a quick link
id: string, input: object
enrollmentsread-only
List enrollments for sections with user details.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page.…
after?, archived?, first: integer, orderBy?, searchText?, sectionIds: array, userIds?
experimentsread-only
Retrieve experiments with metadata and author info
foldersread-only
Browse folders with pagination and ownership filters.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next…
after?, deleted?, first: integer, ids?, orderBy?, ownerId?, parentId?, searchText?, … (list cut; the site may define more)
formativeLibraryListingsread-only
Search formative library listings with filters.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page.…
after?, first: integer, grades?, orderBy?, orgs?, public?, published?, searchText?, … (list cut; the site may define more)
getCurrentPageContextread-only
Get the current Formative page route, focused element, and normalized entity IDs.
getFormativesread-only
Query formatives (assessments/lessons) with filters and pagination. Results are filtered based on the authenticated user's permissions.
Supports cursor-based pagination: use `first` to set page size (default 20, max…
first: integer, after?, ids?, userId?, folderId?, assigned?, searchText?, deleted?, … (list cut; the site may define more)
getOrgsread-only
Query organizations with filters and pagination. Results are filtered based on the authenticated user's permissions.
Supports cursor-based pagination: use `first` to set page size (default 50, max 500) and `after`…
first: integer, after?, ids?, searchTerm?, type?, verified?, includeDescendants?
getSectionsread-only
Query sections (classes) with filters and pagination. Note: In Formative, "section" and "class" are interchangeable terms. Results are filtered based on the authenticated user's permissions.
Supports cursor-based…
first: integer, after?, ids?, userId?, orgId?, orgs?, archived?
getStudentAssignmentsread-only
Get student assignments for a formative.
Returns assignments that are either public (guest) or assigned to a class
that the specified user is in.
No filtering is done with respect to whether the assignment is…
formativeId: string, userId?
getTeacherAssignmentsread-only
Get teacher assignments for a formative.
Returns assignments that the authenticated user can see based on their permissions:
- Teachers see assignments for their own sections
- Org admins see assignments for sections…
formativeId: string, sections?, orgs?, teachers?, archived?, guest?, preview?, createdBefore?, … (list cut; the site may define more)
getUsersread-only
Query users with filters and pagination. Results are filtered based on the authenticated user's permissions.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the…
first: integer, after?, ids?, orgs?, sections?, searchText?, teacher?, student?, … (list cut; the site may define more)
itemBankItemsread-only
Query item bank items with filters by bank, grade, and subject.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch…
after?, first: integer, grades?, itemBankIds?, subjects?, subtypes?
itemBankQuestionsCountread-only
Return aggregate count of item bank questions
grades?, itemBankIds?, subjects?, subtypes?
oneRosterread-only
Fetch a OneRoster import with configuration and org details
rosterId: string, withFiles
oneRosterAcademicSessionsread-only
List OneRoster academic sessions with parent relationships.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the…
rosterId: string, after?, first: integer, orderBy?, parentSourcedId?, sourcedIds?, title?, type?, … (list cut; the site may define more)
oneRosterAnalysisread-only
View OneRoster sync analysis and stats
rosterId: string
oneRosterClassesread-only
Browse OneRoster classes with related course and school info.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch…
rosterId: string, after?, courseSourcedIds?, first: integer, grades?, orderBy?, schoolSourcedIds?, sourcedIds?, … (list cut; the site may define more)
oneRosterCoursesread-only
List OneRoster courses with school year and org details.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the…
rosterId: string, after?, courseCode?, first: integer, grades?, orderBy?, orgSourcedIds?, sourcedIds?, … (list cut; the site may define more)
oneRosterDemographicsread-only
List OneRoster demographics for roster users.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The…
rosterId: string, after?, first: integer, orderBy?, sourcedIds?
oneRosterEnrollmentsread-only
List OneRoster enrollments with class and user context.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next…
rosterId: string, after?, classSourcedIds?, first: integer, orderBy?, roles?, schoolSourcedIds?, sourcedIds?, … (list cut; the site may define more)
oneRosterOrgsread-only
List OneRoster orgs for a roster with pagination.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page.…
rosterId: string, after?, first: integer, orderBy?, sourcedIds?, name?, types?
oneRosterRolesread-only
List OneRoster roles with associated users and schools.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next…
rosterId: string, after?, first: integer, orderBy?, roles?, schoolSourcedIds?, sourcedIds?, status?, … (list cut; the site may define more)
oneRosterUsersread-only
List OneRoster users within a roster with PII redaction.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the…
rosterId: string, after?, first: integer, email?, familyName?, givenName?, grades?, roles?, … (list cut; the site may define more)
oneRostersread-only
List OneRoster imports with status and org context.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next…
active?, activitySince?, after?, first: integer, name?, orderBy?, orgs?
orgInvitesByEmailread-only
Lookup organization invites sent to an email address
email: string
orgPlansread-only
List available org billing plans
practiceSessionsread-only
List practice sessions for a practice set.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The…
after?, completed?, first: integer, orderBy?, ownerId?, practiceSetId: string, type?
prepareUpload
Prepare a file upload and return signed details
input: object
quickLinksread-only
Fetch quick links for a user or folder.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The…
after?, first: integer, orderBy?, parentFolderId?, searchText?, type?, userId?
removeFolder
Remove a folder
id: string
removeSection
Delete a section
id: string
rubricTemplatesread-only
List rubric templates.
Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes…
after?, first: integer
saveAnswer
Save a student's answer to a formative item (question).
**IMPORTANT**: A submission must exist before saving answers. Use saveSubmission first.
**Answer Content Formats** (by question…
input: object
saveDrawingParts
Save drawing annotations for an answer.
This is used for questions with drawing enabled (e.g., show your work, long answer with drawing).
Each drawing part represents an SVG path.
**IMPORTANT**: A submission must…
input: object
saveFormativeLibraryListing
Create or update a formative library listing
input: object
saveLibraryBundle
Save a library bundle
input: object
saveSubmission
Create or update a submission for a formative.
A submission represents a student's attempt at completing a formative. It tracks:
- Whether the student has started the formative
- Whether they have submitted their…
input: object
First 60 of 86 shown.