Teachable
App · 20 actions
Run your Teachable school from your workflows: read courses, lectures, quizzes, students, sales and pricing plans, create students, enroll and unenroll them, and mark lectures complete.
Actions
| Action | What it does |
|---|---|
| Create user | Create a student account in your school. |
| Enroll user | Enroll a user in a course. |
| Get course | Get a course with its author and curriculum: every section and the ids of its lectures. |
| Get course progress | Get how far one student is through a course: percent complete, completion date, certificate and each lecture. |
| Get lecture | Get a lecture and its attachments: text, files, videos and quizzes. |
| Get pricing plan | Get a pricing plan with its price, billing schedule, trial length and enrollment cap. |
| Get quiz | Get a quiz with its questions, answer choices and correct answers. |
| Get quiz responses | Get every student's submitted result for a quiz: who answered, when, and the percent they got right. |
| Get user | Get a user with their role, tags and every course they are enrolled in. |
| List course enrollments | List the students enrolled in a course with when they enrolled and how far they have got. |
| List courses | List the courses in your school, optionally by name, status or author. |
| List pricing plans | List the pricing plans in your school. |
| List quizzes | List the ids of the quizzes in a lecture. |
| List transactions | List the sales in your school with price, tax, revenue and refund details, optionally for one student, course or pricing plan. |
| List users | List the users in your school, or find one by email. |
| List webhook events | List the deliveries of one webhook, with the HTTP status your receiver answered, to find the ones that failed. |
| List webhooks | List the webhooks set up in your school with the event each one listens for and where it sends it. |
| Mark lecture complete | Mark a lecture as complete for a student who is enrolled in its course. |
| Unenroll user | Take a user out of a course. |
| Update user | Change a user's name or signup source. |
Create user
Create a student account in your school. Teachable has no way to delete one through the API.
Inputs
- Email
emailtextRequired - The new student's email address.
- Name
nametext - The new student's name.
- Password
passwordtext - A password for the account, at least 6 characters. Leave empty and the student sets their own.
- Signup source
sourcetext - Where the student came from, such as a campaign name. Teachable shows it on the student's profile.
Outputs
userobject- The new user
Example output
{
"user": {
"courses": [],
"email": "jo@example.com",
"id": 2001,
"last_sign_in_ip": null,
"name": "Jo Bloggs",
"role": "student",
"tags": []
}
}Enroll user
Enroll a user in a course.
Inputs
- Student ID
student_idtextRequired - The student's id, from 'List users' or an earlier step.
- Course
course_idtextRequired - The course. Pick one, or give its id from an earlier step.
Outputs
course_idnumber- The course
enrolledtrue/false- Always true once Teachable accepts the request
user_idnumber- The student
Example output
{
"course_id": 1001,
"enrolled": true,
"user_id": 2001
}Get course
Get a course with its author and curriculum: every section and the ids of its lectures.
Inputs
- Course
course_idtextRequired - The course. Pick one, or give its id from an earlier step.
Outputs
courseobject- The course
Example output
{
"course": {
"author_bio": {
"bio": null,
"name": "Jo Baker",
"profile_image_url": null,
"user_id": 2002
},
"description": null,
"heading": "Bread from scratch",
"id": 1001,
"image_url": null,
"is_published": true,
"lecture_sections": [
{
"id": 4001,
"is_published": true,
"lectures": [
{
"id": 5001,
"is_published": true,
"position": 1
}
],
"name": "Getting started",
"position": 1
}
],
"name": "Intro to Baking"
}
}Get course progress
Get how far one student is through a course: percent complete, completion date, certificate and each lecture.
Inputs
- Course
course_idtextRequired - The course. Pick one, or give its id from an earlier step.
- Student ID
student_idtextRequired - The student's id, from 'List users' or an earlier step.
- Page
pagenumber - Which page of results to return. Leave empty for the first.At least 1.
- Results per page
pernumber - How many results to return on a page, up to 20. Leave empty for Teachable's default.From 1 to 20.
Outputs
course_progressobject- The student's progress
metaobject- Paging of the sections
Example output
{
"course_progress": {
"certificate": {
"issued_at": null,
"page_id": null,
"serial_number": null
},
"completed_at": null,
"enrolled_at": "2026-10-01T09:00:00Z",
"id": 1001,
"lecture_sections": [],
"percent_complete": 10
},
"meta": {
"from": 1,
"number_of_pages": 1,
"page": 1,
"per_page": 20,
"to": 1,
"total": 1
}
}Get lecture
Get a lecture and its attachments: text, files, videos and quizzes.
Inputs
- Course
course_idtextRequired - The course. Pick one, or give its id from an earlier step.
- Lecture
lecture_idtextRequired - The lecture in that course. Pick one, or give its id from 'Get course' or an earlier step.
Outputs
lectureobject- The lecture
Example output
{
"lecture": {
"attachments": [],
"id": 5001,
"is_published": true,
"lecture_section_id": 4001,
"name": "Welcome",
"position": 1
}
}Get pricing plan
Get a pricing plan with its price, billing schedule, trial length and enrollment cap. Only plans for courses are supported.
Inputs
- Pricing plan
pricing_plan_idtextRequired - The pricing plan. Pick one, or give its id from an earlier step.
Outputs
pricing_planobject- The plan
Example output
{
"pricing_plan": {
"course_id": 1001,
"created_at": "2026-09-01T09:00:00Z",
"currency": "USD",
"description": null,
"enrollment_cap": null,
"free_trial_length": null,
"frequency": {
"access_limit_date": null,
"access_limit_duration": null,
"access_limit_interval": null,
"billing_interval": null,
"billing_interval_count": null,
"type": "one_time"
},
"id": 3001,
"name": "Full price",
"price": 4900,
"updated_at": "2026-09-01T09:00:00Z"
}
}Get quiz
Get a quiz with its questions, answer choices and correct answers.
Inputs
- Course
course_idtextRequired - The course. Pick one, or give its id from an earlier step.
- Lecture
lecture_idtextRequired - The lecture in that course. Pick one, or give its id from 'Get course' or an earlier step.
- Quiz ID
quiz_idtextRequired - The quiz's id, from 'List quizzes' or an earlier step.
Outputs
quizobject- The quiz
Example output
{
"quiz": {
"id": 5001,
"kind": "quiz",
"name": "Quiz 1",
"position": 1,
"quiz": {
"id": 9001,
"questions": [],
"type": "Quiz"
}
}
}Get quiz responses
Get every student's submitted result for a quiz: who answered, when, and the percent they got right.
Inputs
- Course
course_idtextRequired - The course. Pick one, or give its id from an earlier step.
- Lecture
lecture_idtextRequired - The lecture in that course. Pick one, or give its id from 'Get course' or an earlier step.
- Quiz ID
quiz_idtextRequired - The quiz's id, from 'List quizzes' or an earlier step.
Outputs
countnumber- How many results
course_idnumber- The course
course_nametext- The course's name
gradedtrue/false- Whether the quiz is graded
lecture_idnumber- The lecture
lecture_nametext- The lecture's name
responseslist- The submitted results
Example output
{
"count": 1,
"course_id": 1001,
"course_name": "Intro to Baking",
"graded": true,
"lecture_id": 5001,
"lecture_name": "Welcome",
"responses": [
{
"percent_correct": 80,
"student_email": "jo@example.com",
"student_id": 2001,
"student_name": "Jo Bloggs",
"submitted_at": "2026-10-02T09:00:00Z"
}
]
}Get user
Get a user with their role, tags and every course they are enrolled in.
Inputs
- Student ID
student_idtextRequired - The student's id, from 'List users' or an earlier step.
Outputs
userobject- The user
Example output
{
"user": {
"courses": [
{
"completed_at": null,
"course_id": 1001,
"course_name": "Intro to Baking",
"enrolled_at": "2026-10-01T09:00:00Z",
"is_active_enrollment": true,
"percent_complete": 10
}
],
"email": "jo@example.com",
"id": 2001,
"last_sign_in_ip": null,
"name": "Jo Bloggs",
"role": "student",
"tags": []
}
}List course enrollments
List the students enrolled in a course with when they enrolled and how far they have got.
Inputs
- Course
course_idtextRequired - The course. Pick one, or give its id from an earlier step.
- Enrolled after
enrolled_afterdate and time - Only students who enrolled after this date and time.
- Enrolled before
enrolled_beforedate and time - Only students who enrolled before this date and time.
- Order
sort_directiontext - Which enrollments come first.One of:
asc(Oldest enrollment first),desc(Newest enrollment first).
Outputs
countnumber- How many records are on this page
enrollmentslist- The enrollments
metaobject- Paging: total, page, number_of_pages and so on
Example output
{
"count": 1,
"enrollments": [
{
"completed_at": null,
"enrolled_at": "2026-10-01T09:00:00Z",
"expires_at": null,
"percent_complete": 10,
"user_id": 2001
}
],
"meta": {
"from": 1,
"number_of_pages": 1,
"page": 1,
"per_page": 20,
"to": 1,
"total": 1
}
}List courses
List the courses in your school, optionally by name, status or author.
Inputs
- Name contains
nametext - Only courses whose name matches this text.
- Status
publishedtext - Only published or only unpublished courses. Leave empty for both.One of:
published(Published courses only),unpublished(Unpublished courses only). - Author bio ID
author_bio_idtext - Only courses by this author, by the author bio's id.
- Created at
created_atdate and time - Only courses created at this date and time.
- Page
pagenumber - Which page of results to return. Leave empty for the first.At least 1.
- Results per page
pernumber - How many results to return on a page, up to 20. Leave empty for Teachable's default.From 1 to 20.
Outputs
countnumber- How many records are on this page
courseslist- The courses
metaobject- Paging: total, page, number_of_pages and so on
Example output
{
"count": 1,
"courses": [
{
"description": null,
"heading": "Bread from scratch",
"id": 1001,
"image_url": null,
"is_published": true,
"name": "Intro to Baking"
}
],
"meta": {
"from": 1,
"number_of_pages": 1,
"page": 1,
"per_page": 20,
"to": 1,
"total": 1
}
}List pricing plans
List the pricing plans in your school.
Inputs
- Page
pagenumber - Which page of results to return. Leave empty for the first.At least 1.
- Results per page
pernumber - How many results to return on a page, up to 20. Leave empty for Teachable's default.From 1 to 20.
Outputs
countnumber- How many records are on this page
metaobject- Paging: total, page, number_of_pages and so on
pricing_planslist- The pricing plans
Example output
{
"count": 1,
"meta": {
"from": 1,
"number_of_pages": 1,
"page": 1,
"per_page": 20,
"to": 1,
"total": 1
},
"pricing_plans": [
{
"course_id": 1001,
"created_at": "2026-09-01T09:00:00Z",
"currency": "USD",
"id": 3001,
"name": "Full price",
"price": 4900,
"updated_at": "2026-09-01T09:00:00Z"
}
]
}List quizzes
List the ids of the quizzes in a lecture.
Inputs
- Course
course_idtextRequired - The course. Pick one, or give its id from an earlier step.
- Lecture
lecture_idtextRequired - The lecture in that course. Pick one, or give its id from 'Get course' or an earlier step.
Outputs
countnumber- How many quizzes
quiz_idslist- The ids of the lecture's quizzes
Example output
{
"count": 1,
"quiz_ids": [
5002
]
}List transactions
List the sales in your school with price, tax, revenue and refund details, optionally for one student, course or pricing plan. A new sale can take up to two minutes to appear.
Inputs
- Student ID
student_idtext - Only this student, by id. Leave empty for everyone.
- Course
course_idtext - Only this course. Pick one, or give its id; leave empty for all.
- Pricing plan
pricing_plan_idtext - Only sales of this pricing plan. Leave empty for all.
- Refunds
fully_refundedtext - Filter by whether the sale was fully refunded. Leave empty for all.One of:
yes(Only fully refunded sales),no(Only sales that are not fully refunded). - Chargebacks
chargebacktext - Filter by whether the sale has a chargeback. Leave empty for all.One of:
yes(Only sales with a chargeback),no(Only sales without a chargeback). - From
startdate and time - Only sales after this date and time (not including it).
- Until
enddate and time - Only sales up to this date and time (including it).
- Page
pagenumber - Which page of results to return. Leave empty for the first.At least 1.
- Results per page
pernumber - How many results to return on a page, up to 20. Leave empty for Teachable's default.From 1 to 20.
Outputs
countnumber- How many records are on this page
metaobject- Paging: total, page, number_of_pages and so on
transactionslist- The sales
Example output
{
"count": 1,
"meta": {
"from": 1,
"number_of_pages": 1,
"page": 1,
"per_page": 20,
"to": 1,
"total": 1
},
"transactions": [
{
"affiliate_fees": 0,
"affiliate_id": null,
"amount_refunded": 0,
"author_fees": 0,
"author_id": null,
"charge": 4900,
"chargeback_fee": null,
"coupon_id": null,
"created_at": "2026-10-02T09:00:00Z",
"currency": "USD",
"final_price": 4900,
"has_chargeback": false,
"id": 9001,
"pricing_plan_id": 3001,
"purchased_at": "2026-10-02T09:00:00Z",
"refunded_at": null,
"revenue": 4500,
"sale_id": 9101,
"status": "paid",
"tax_charge": 0,
"user_id": 2001
}
]
}List users
List the users in your school, or find one by email.
Inputs
- Email
emailtext - Only the user with this email address.
- Page
pagenumber - Which page of results to return. Leave empty for the first.At least 1.
- Results per page
pernumber - How many results to return on a page, up to 20. Leave empty for Teachable's default.From 1 to 20.
Outputs
countnumber- How many records are on this page
metaobject- Paging: total, page, number_of_pages and so on
userslist- The users
Example output
{
"count": 1,
"meta": {
"from": 1,
"number_of_pages": 1,
"page": 1,
"per_page": 20,
"to": 1,
"total": 1
},
"users": [
{
"email": "jo@example.com",
"id": 2001,
"name": "Jo Bloggs"
}
]
}List webhook events
List the deliveries of one webhook, with the HTTP status your receiver answered, to find the ones that failed.
Inputs
- Webhook
webhook_idtextRequired - The webhook. Pick one, or give its id from 'List webhooks'.
- Response status from
status_fromnumber - Only deliveries your receiver answered with this HTTP status or higher, such as 400 to find failures.From 100 to 599.
- Response status to
status_tonumber - Only deliveries answered with this HTTP status or lower.From 100 to 599.
- Created after
created_afterdate and time - Only deliveries created after this date and time.
- Created before
created_beforedate and time - Only deliveries created before this date and time.
- Page
pagenumber - Which page of results to return. Leave empty for the first.At least 1.
- Results per page
pernumber - How many results to return on a page, up to 20. Leave empty for Teachable's default.From 1 to 20.
Outputs
countnumber- How many records are on this page
eventslist- The deliveries
metaobject- Paging: total, page, number_of_pages and so on
Example output
{
"count": 1,
"events": [
{
"attempt_count": 1,
"created_at": "2026-10-02T09:00:00Z",
"id": 7001,
"last_attempted_at": "2026-10-02T09:00:00Z",
"object_id": 8001,
"object_type": "Enrollment",
"response_http_status": 200,
"webhook_id": 6001,
"workflow_state": "delivered"
}
],
"meta": {
"from": 1,
"number_of_pages": 1,
"page": 1,
"per_page": 20,
"to": 1,
"total": 1
}
}List webhooks
List the webhooks set up in your school with the event each one listens for and where it sends it.
Inputs
None.
Outputs
countnumber- How many webhooks
metaobject- Empty: this list is not paged
webhookslist- The webhooks
Example output
{
"count": 1,
"meta": {},
"webhooks": [
{
"event_trigger": "Enrollment.created",
"id": 6001,
"url": "https://example.com/teachable",
"webhook_events_count": 12,
"workflow_state": "active"
}
]
}Mark lecture complete
Mark a lecture as complete for a student who is enrolled in its course.
Inputs
- Course
course_idtextRequired - The course. Pick one, or give its id from an earlier step.
- Lecture
lecture_idtextRequired - The lecture in that course. Pick one, or give its id from 'Get course' or an earlier step.
- Student ID
student_idtextRequired - The student's id, from 'List users' or an earlier step.
Outputs
completedtrue/false- Always true once Teachable accepts the request
course_idnumber- The course
lecture_idnumber- The lecture
user_idnumber- The student
Example output
{
"completed": true,
"course_id": 1001,
"lecture_id": 5001,
"user_id": 2001
}Unenroll user
Take a user out of a course.
Inputs
- Student ID
student_idtextRequired - The student's id, from 'List users' or an earlier step.
- Course
course_idtextRequired - The course. Pick one, or give its id from an earlier step.
Outputs
course_idnumber- The course
unenrolledtrue/false- Always true once Teachable accepts the request
user_idnumber- The student
Example output
{
"course_id": 1001,
"unenrolled": true,
"user_id": 2001
}Update user
Change a user's name or signup source.
Inputs
- Student ID
student_idtextRequired - The student's id, from 'List users' or an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Signup source
sourcetext - A new signup source. Leave empty to keep it.
Outputs
userobject- The user after the change
Example output
{
"user": {
"courses": [
{
"completed_at": null,
"course_id": 1001,
"course_name": "Intro to Baking",
"enrolled_at": "2026-10-01T09:00:00Z",
"is_active_enrollment": true,
"percent_complete": 10
}
],
"email": "jo@example.com",
"id": 2001,
"last_sign_in_ip": null,
"name": "Jo Bloggs",
"role": "student",
"tags": []
}
}