Skip to main content
Heights Platform logo
  • Category: online courses
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 16
  • Triggers: 0
  • Slug: HEIGHTS_PLATFORM
  • Version: 20261101_00

Tools

Slug: HEIGHTS_PLATFORM_ENROLL_STUDENTCreate a student or update an existing student and mark them enrolled without granting course or bundle access. Use Grant Student Access when the student should also receive a learning product.

Input Parameters

string
Student name. Heights requires this when the email does not already identify a student.
string
required
Email address of the student to create, update, or enroll.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_GET_LEARNING_PRODUCTGet detailed metadata for one course, bundle, or digital product by ID.

Input Parameters

integer
required
Course, bundle, or digital product ID returned by List Learning Products.
string ("course" | "bundle" | "digital_product")
required
Type of learning product to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_GET_ORDERGet one Heights order by its public unique order ID.

Input Parameters

string
required
Public order ID returned by List Orders or a new_order webhook payload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_GET_STUDENT_COURSE_PROGRESSGet a student’s overall and course-specific completion percentages for one course.

Input Parameters

integer
required
Course ID whose completion percentage should be inspected.
string
required
Email address of the student whose progress should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_GET_STUDENT_DETAILSGet a student by email, including account attributes, activity counts, paid orders, and enrolled courses.

Input Parameters

string
required
Exact email address of the student to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_GRANT_STUDENT_ACCESSGrant one course or bundle to a student by creating a zero-dollar paid order. Heights also creates or updates the student and marks them enrolled. This is non-idempotent because retrying can create another access order; do not automatically retry an ambiguous result.

Input Parameters

integer
required
ID of the course or bundle to grant. The ID type must match resource_type.
string
Student name. Heights requires this when the email does not already identify a student.
string ("course" | "bundle")
required
Type of learning product to grant: course or bundle.
string
required
Email address of the student who should receive access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_GRANT_STUDENT_ROLEGrant one Heights role to a student, changing the student’s authorization. Use a role ID returned by List Course Roles.

Input Parameters

integer
required
Role ID returned by List Course Roles.
string
required
Email address of the student who should receive the role.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_LIST_COURSE_ROLESList the Heights roles that can be granted to students.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_LIST_LEARNING_PRODUCTSList published courses, bundles, or digital products in the connected Heights account.

Input Parameters

string ("course" | "bundle" | "digital_product")
required
Type of learning product to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_LIST_ORDERSList Heights orders one page at a time, with status, student email, and creation-time filters and an opaque continuation cursor. The status defaults to paid; select all to include every status.

Input Parameters

string ("pending" | "failed" | "paid" | "paypal_executed" | "all")
Order status to return; use ‘all’ to include every status.
integer
Maximum orders to return in this page (1-100).
string
Opaque continuation cursor returned by a previous List Orders call; it retains the original filters and page size.
string
Return orders created at or after this ISO 8601 timestamp.
string
Return only orders for this exact student email address.
string
Return orders created at or before this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_LIST_STUDENTSList all Heights students one page at a time, or list the unpaginated students whose total completion is at least 100 percent.

Input Parameters

string
Continuation cursor returned by a previous all-students page; omit when completion_filter is ‘completed’.
string ("all" | "completed")
Whether to list all students or only students whose total completion is at least 100 percent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_LIST_STUDENT_SUBMISSIONSList assignment answers or project posts submitted by students.

Input Parameters

string ("assignment_answer" | "project_post")
required
Type of student submission to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_RESET_STUDENT_PROGRESSPermanently erase a student’s saved completion and progress records. For a course, this resets the selected course only. For a bundle, this resets every course in that bundle. This destructive change cannot be undone; confirm the student, resource type, and resource ID before calling. Do not automatically retry an ambiguous result.

Input Parameters

integer
required
ID of the course or bundle whose saved progress will be permanently erased. The ID type must match resource_type.
string ("course" | "bundle")
required
Scope of the permanent reset: course erases progress for one course; bundle erases progress for every course in the bundle.
string
required
Email address of the student whose saved progress will be permanently erased.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_REVOKE_STUDENT_ACCESSPermanently remove one course or bundle from a student’s existing orders. Course revocation removes that course from every applicable order. Bundle revocation cascades: it removes the bundle and the bundle’s courses and digital products from the student’s orders. This can immediately remove content access and is not automatically reversible; verify the student, resource type, and resource ID before calling.

Input Parameters

integer
required
ID of the course or bundle whose access should be permanently revoked.
string
Student name. Required for course revocation; ignored and not sent for bundle revocation.
string ("course" | "bundle")
required
Type of access to revoke. Revoking a bundle also removes its courses and digital products from the student’s orders.
string
required
Email address of the student whose access should be revoked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_REVOKE_STUDENT_ROLERevoke one Heights role from a student, changing the student’s authorization. Use a role ID returned by List Course Roles.

Input Parameters

integer
required
Role ID returned by List Course Roles.
string
required
Email address of the student whose role should be revoked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEIGHTS_PLATFORM_UNENROLL_STUDENTEnd a student’s paid membership by setting their Heights paying-student state to false. This changes the student’s membership state; it does not delete the student account or promise to remove separately granted course or bundle access.

Input Parameters

string
required
Name of the student to unenroll, required by this Heights endpoint.
string
required
Email address of the student whose paid membership should be ended.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not