> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Heights Platform

> Heights Platform helps creators build and sell online courses, digital products, and communities while managing students, orders, and access.

![Heights Platform logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/heights_platform.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=b831446909d568815646557fd755f58a)

* **Category:** online courses
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 16
* **Triggers:** 0
* **Slug:** `HEIGHTS_PLATFORM`
* **Version:** 20261101\_00

## Tools

> [accordion] Enroll Student
>
> **Slug:** `HEIGHTS_PLATFORM_ENROLL_STUDENT`
>
> Create 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
>
> **student\_name** `string`
>
> Student name. Heights requires this when the email does not already identify a student.
>
> **student\_email** `string` *required*
>
> Email address of the student to create, update, or enroll.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Learning Product
>
> **Slug:** `HEIGHTS_PLATFORM_GET_LEARNING_PRODUCT`
>
> Get detailed metadata for one course, bundle, or digital product by ID.
>
> #### Input Parameters
>
> **resource\_id** `integer` *required*
>
> Course, bundle, or digital product ID returned by List Learning Products.
>
> **resource\_type** `string ("course" | "bundle" | "digital_product")` *required*
>
> Type of learning product to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Order
>
> **Slug:** `HEIGHTS_PLATFORM_GET_ORDER`
>
> Get one Heights order by its public unique order ID.
>
> #### Input Parameters
>
> **order\_id** `string` *required*
>
> Public order ID returned by List Orders or a new\_order webhook payload.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Student Course Progress
>
> **Slug:** `HEIGHTS_PLATFORM_GET_STUDENT_COURSE_PROGRESS`
>
> Get a student's overall and course-specific completion percentages for one course.
>
> #### Input Parameters
>
> **course\_id** `integer` *required*
>
> Course ID whose completion percentage should be inspected.
>
> **student\_email** `string` *required*
>
> Email address of the student whose progress should be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Student Details
>
> **Slug:** `HEIGHTS_PLATFORM_GET_STUDENT_DETAILS`
>
> Get a student by email, including account attributes, activity counts, paid orders, and enrolled courses.
>
> #### Input Parameters
>
> **student\_email** `string` *required*
>
> Exact email address of the student to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Grant Student Access
>
> **Slug:** `HEIGHTS_PLATFORM_GRANT_STUDENT_ACCESS`
>
> Grant 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
>
> **resource\_id** `integer` *required*
>
> ID of the course or bundle to grant. The ID type must match resource\_type.
>
> **student\_name** `string`
>
> Student name. Heights requires this when the email does not already identify a student.
>
> **resource\_type** `string ("course" | "bundle")` *required*
>
> Type of learning product to grant: course or bundle.
>
> **student\_email** `string` *required*
>
> Email address of the student who should receive access.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Grant Student Role
>
> **Slug:** `HEIGHTS_PLATFORM_GRANT_STUDENT_ROLE`
>
> Grant one Heights role to a student, changing the student's authorization. Use a role ID returned by List Course Roles.
>
> #### Input Parameters
>
> **role\_id** `integer` *required*
>
> Role ID returned by List Course Roles.
>
> **student\_email** `string` *required*
>
> Email address of the student who should receive the role.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Course Roles
>
> **Slug:** `HEIGHTS_PLATFORM_LIST_COURSE_ROLES`
>
> List the Heights roles that can be granted to students.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Learning Products
>
> **Slug:** `HEIGHTS_PLATFORM_LIST_LEARNING_PRODUCTS`
>
> List published courses, bundles, or digital products in the connected Heights account.
>
> #### Input Parameters
>
> **resource\_type** `string ("course" | "bundle" | "digital_product")` *required*
>
> Type of learning product to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Orders
>
> **Slug:** `HEIGHTS_PLATFORM_LIST_ORDERS`
>
> List 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
>
> **status** `string ("pending" | "failed" | "paid" | "paypal_executed" | "all")`
>
> Order status to return; use 'all' to include every status.
>
> **page\_size** `integer`
>
> Maximum orders to return in this page (1-100).
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous List Orders call; it retains the original filters and page size.
>
> **created\_after** `string`
>
> Return orders created at or after this ISO 8601 timestamp.
>
> **student\_email** `string`
>
> Return only orders for this exact student email address.
>
> **created\_before** `string`
>
> Return orders created at or before this ISO 8601 timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Students
>
> **Slug:** `HEIGHTS_PLATFORM_LIST_STUDENTS`
>
> List all Heights students one page at a time, or list the unpaginated students whose total completion is at least 100 percent.
>
> #### Input Parameters
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous all-students page; omit when completion\_filter is 'completed'.
>
> **completion\_filter** `string ("all" | "completed")`
>
> Whether to list all students or only students whose total completion is at least 100 percent.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Student Submissions
>
> **Slug:** `HEIGHTS_PLATFORM_LIST_STUDENT_SUBMISSIONS`
>
> List assignment answers or project posts submitted by students.
>
> #### Input Parameters
>
> **submission\_type** `string ("assignment_answer" | "project_post")` *required*
>
> Type of student submission to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Reset Student Progress
>
> **Slug:** `HEIGHTS_PLATFORM_RESET_STUDENT_PROGRESS`
>
> Permanently 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
>
> **resource\_id** `integer` *required*
>
> ID of the course or bundle whose saved progress will be permanently erased. The ID type must match resource\_type.
>
> **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.
>
> **student\_email** `string` *required*
>
> Email address of the student whose saved progress will be permanently erased.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Revoke Student Access
>
> **Slug:** `HEIGHTS_PLATFORM_REVOKE_STUDENT_ACCESS`
>
> Permanently 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
>
> **resource\_id** `integer` *required*
>
> ID of the course or bundle whose access should be permanently revoked.
>
> **student\_name** `string`
>
> Student name. Required for course revocation; ignored and not sent for bundle revocation.
>
> **resource\_type** `string ("course" | "bundle")` *required*
>
> Type of access to revoke. Revoking a bundle also removes its courses and digital products from the student's orders.
>
> **student\_email** `string` *required*
>
> Email address of the student whose access should be revoked.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Revoke Student Role
>
> **Slug:** `HEIGHTS_PLATFORM_REVOKE_STUDENT_ROLE`
>
> Revoke one Heights role from a student, changing the student's authorization. Use a role ID returned by List Course Roles.
>
> #### Input Parameters
>
> **role\_id** `integer` *required*
>
> Role ID returned by List Course Roles.
>
> **student\_email** `string` *required*
>
> Email address of the student whose role should be revoked.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unenroll Student
>
> **Slug:** `HEIGHTS_PLATFORM_UNENROLL_STUDENT`
>
> End 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
>
> **student\_name** `string` *required*
>
> Name of the student to unenroll, required by this Heights endpoint.
>
> **student\_email** `string` *required*
>
> Email address of the student whose paid membership should be ended.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
