Thinkific

App · 25 actions

Manage learners, enrollments and groups, and read courses, chapters, products, orders, collections and instructors.

Actions

ActionWhat it does
Create enrollmentCreate enrollment.
Create groupCreate Group.
Create userCreate user.
Delete groupDelete Group by ID.
Delete userDelete user by ID.
Get courseGet courses by ID.
Get enrollmentGet enrollments by ID.
Get groupGet Group.
Get orderGet orders by ID.
Get productGet product by ID.
Get userList Users by ID.
List chapter contentsGet Contents by Chapter id.
List collection productsGet products by Collections id.
List collectionsGet Collections.
List course chaptersGet Chapters by Course ID.
List coursesGet Courses.
List enrollmentsGet Enrollments.
List groupsGet Groups.
List instructorsGet Instructors.
List ordersGet Orders.
List productsList products.
List profile fieldsGet Custom profile field definition.
List usersList Users.
Update enrollmentUpdate enrollment.
Update userUpdate user by ID.

Create enrollment

Create enrollment.

Inputs

Coursecourse_idnumberRequired
The ID of the Course as an integer.
Learner IDperson_idnumberRequired
The ID of the User owning the Enrollment as an integer.
Activated atactivated_atdate and time
The date/time at which the Enrollment is activated. If not provided, the Enrollment is a free trial.
Expiry dateexpiry_datedate and time
The date/time at which the Enrollment expired. If not provided, the Enrollment does not expire.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "activated_at": "example",
    "completed": false,
    "completed_at": "example",
    "course_id": 1.0,
    "course_name": "example",
    "expired": false,
    "expiry_date": "example",
    "id": 1.0,
    "is_free_trial": false,
    "percentage_completed": 1.0,
    "started_at": "example",
    "updated_at": "example",
    "user_email": "example",
    "user_id": 1.0,
    "user_name": "example"
  }
}

Create group

Create Group.

Inputs

NamenametextRequired
The name of the Group

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "created_at": "example",
    "id": 1.0,
    "name": "example",
    "token": "example"
  }
}

Create user

Create user.

Inputs

First namefirst_nametextRequired
User's first name
Last namelast_nametextRequired
User's last name
EmailemailtextRequired
User's email
Passwordpasswordtext
The password of the User. If not included, the Express Sign In Link becomes activated for the User. Fetch it with `POST /users/{id}/express_sign_in_link` and treat it like a password.
Rolesroleslist
User's rolesOne or more of: affiliate, course_admin (Course admin), group_analyst (Group analyst), site_admin (Site admin).
Biobiotext
User's bio
Companycompanytext
User's Company Name
Headlineheadlinetext
User's headline
Affiliate codeaffiliate_codetext
User's affiliate code
Affiliate commissionaffiliate_commissionnumber
Required only if the User is an affiliate. This should be greater than 0 and less than or equal to 100 if the type is percentage or lower than 9999.99 if is a fixed type.
Affiliate commission typeaffiliate_commission_typetext
The affiliate payout type, it can be either % (percentage, default) or $ (fixed amount). Required only if the User is an affiliate.
Affiliate payout emailaffiliate_payout_emailtext
The email of the User. Required only if the user is an affiliate. Used to pay the User out.
Custom profile fieldscustom_profile_fieldslist
Custom profile fields for the User.
Skip custom fields validationskip_custom_fields_validationtrue/false
Option to skip required custom profile fields validation.Default: false.
Send welcome emailsend_welcome_emailtrue/false
Option to send the Site Welcome email to the User. Leave it false when your system delivers the Express Sign In Link itself through `POST /users/{id}/express_sign_in_link`.Default: false.
External IDexternal_idtext
Optional identifier of the user in an external system. Typically used in conjunction with Thinkific's single sign-on. For further information on this, please read [this](https://help.thinkific.com/support/solutions/articles/221622-sso-automatically-sign-in-from-your-own-website)
Providerprovidertext
When using Thinkific single sign-on and providing an external_id, specify the provider type to distinguish which single sign-on type the user should be associated with.One of: SSO, OPENID_CONNECT (Openid connect). Default: SSO.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "administered_course_ids": [],
    "affiliate_code": "example",
    "affiliate_commission": 1.0,
    "affiliate_commission_type": "example",
    "affiliate_payout_email": "example",
    "avatar_url": "example",
    "bio": "example",
    "company": "example",
    "created_at": "example",
    "custom_profile_fields": [],
    "email": "example",
    "external_source": "example",
    "first_name": "example",
    "full_name": "example",
    "headline": "example",
    "id": 1.0,
    "last_name": "example",
    "roles": []
  }
}

Delete group

Delete Group by ID.

Inputs

GroupidnumberRequired
The ID of the Group in the form of an integer.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {}
}

Delete user

Delete user by ID.

Inputs

Learner IDidtextRequired
Accepts a Thinkific generated ID (in the form of an integer), or an External ID (as a string) when accompanied by the "provider" parameter.
Providerprovidertext
Provider from which the user's External Id is associated (Required if using External Id as id parameter)One of: SSO, OPENID_CONNECT (Openid connect).

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {}
}

Get course

Get courses by ID.

Inputs

CourseidnumberRequired
ID of the Course in the form of an integer.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "administrator_user_ids": [],
    "banner_image_url": "example",
    "chapter_ids": [],
    "contact_information": "example",
    "course_card_image_url": "example",
    "course_card_text": "example",
    "description": "example",
    "duration": "example",
    "id": 1.0,
    "instructor_id": 1.0,
    "intro_video_wistia_identifier": "example",
    "intro_video_youtube": "example",
    "keywords": "example",
    "name": "example",
    "product_id": 1.0,
    "reviews_enabled": false,
    "slug": "example",
    "subtitle": "example",
    "user_id": 1.0
  }
}

Get enrollment

Get enrollments by ID.

Inputs

Enrollment IDidnumberRequired
ID of the Enrollment in the form of an integer.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "activated_at": "example",
    "completed": false,
    "completed_at": "example",
    "course_id": 1.0,
    "course_name": "example",
    "expired": false,
    "expiry_date": "example",
    "id": 1.0,
    "is_free_trial": false,
    "percentage_completed": 1.0,
    "started_at": "example",
    "updated_at": "example",
    "user_email": "example",
    "user_id": 1.0,
    "user_name": "example"
  }
}

Get group

Get Group.

Inputs

GroupidnumberRequired
The ID of the Group to fetch.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "created_at": "example",
    "id": 1.0,
    "name": "example",
    "token": "example"
  }
}

Get order

Get orders by ID.

Inputs

Order IDidnumberRequired
ID of the Orders in the form of an integer.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "affiliate_referral_code": "example",
    "amount_cents": 1.0,
    "amount_dollars": "example",
    "coupon_code": "example",
    "coupon_id": 1.0,
    "created at": "example",
    "id": 1.0,
    "items": [],
    "product_id": 1.0,
    "product_name": "example",
    "status": "example",
    "subscription": false,
    "user_email": "example",
    "user_id": 1.0,
    "user_name": "example"
  }
}

Get product

Get product by ID.

Inputs

ProductidnumberRequired
Id of the product in the form of an integer

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "card_image_url": "example",
    "collection_ids": [],
    "created_at": "example",
    "days_until_expiry": 1.0,
    "description": "example",
    "has_certificate": false,
    "hidden": false,
    "id": 1.0,
    "keywords": "example",
    "name": "example",
    "position": 1.0,
    "price": 1.0,
    "private": false,
    "product_prices": [],
    "productable_id": 1.0,
    "productable_type": "example",
    "related_product_ids": [],
    "seo_description": "example",
    "seo_title": "example",
    "slug": "example",
    "status": "example",
    "subscription": false
  }
}

Get user

List Users by ID.

Inputs

Learner IDidtextRequired
Accepts a Thinkific generated ID (in the form of an integer), or an External ID (as a string) when accompanied by the "provider" parameter.
Providerprovidertext
Provider from which the user's External Id is associated (Required if using External Id as id parameter)One of: SSO, OPENID_CONNECT (Openid connect).

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "administered_course_ids": [],
    "affiliate_code": "example",
    "affiliate_commission": 1.0,
    "affiliate_commission_type": "example",
    "affiliate_payout_email": "example",
    "avatar_url": "example",
    "bio": "example",
    "company": "example",
    "created_at": "example",
    "custom_profile_fields": [],
    "email": "example",
    "external_source": "example",
    "first_name": "example",
    "full_name": "example",
    "headline": "example",
    "id": 1.0,
    "last_name": "example",
    "roles": []
  }
}

List chapter contents

Get Contents by Chapter id.

Inputs

Chapter IDidnumberRequired
ID of the Chapter in the form of an integer
Pagepagenumber
The page within the collection to fetch.At least 1. Default: 1.0.
Limitlimitnumber
The number of items to be returned.At least 1. Default: 25.0.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "items": [],
    "meta": {
      "pagination": {
        "current_page": 1.0,
        "entries_info": "example",
        "next_page": 1.0,
        "prev_page": 1.0,
        "total_items": 1.0,
        "total_pages": 1.0
      }
    }
  }
}

List collection products

Get products by Collections id.

Inputs

ProductidnumberRequired
ID of the Chapter in the form of an integer
Pagepagenumber
The page within the collection to fetchAt least 1. Default: 1.0.
Limitlimitnumber
The number of items to be returnedAt least 1. Default: 25.0.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "items": [],
    "meta": {
      "pagination": {
        "current_page": 1.0,
        "entries_info": "example",
        "next_page": 1.0,
        "prev_page": 1.0,
        "total_items": 1.0,
        "total_pages": 1.0
      }
    }
  }
}

List collections

Get Collections.

Inputs

Pagepagenumber
The page within the collection to fetchAt least 1. Default: 1.0.
Limitlimitnumber
The number of items to be returnedAt least 1. Default: 25.0.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "items": [],
    "meta": {
      "pagination": {
        "current_page": 1.0,
        "entries_info": "example",
        "next_page": 1.0,
        "prev_page": 1.0,
        "total_items": 1.0,
        "total_pages": 1.0
      }
    }
  }
}

List course chapters

Get Chapters by Course ID.

Inputs

CourseidnumberRequired
ID of the Chapter in the form of an integer.
Pagepagenumber
The page within the collection to fetch.At least 1. Default: 1.0.
Limitlimitnumber
The number of items to be returned.At least 1. Default: 25.0.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "items": [],
    "meta": {
      "pagination": {
        "current_page": 1.0,
        "entries_info": "example",
        "next_page": 1.0,
        "prev_page": 1.0,
        "total_items": 1.0,
        "total_pages": 1.0
      }
    }
  }
}

List courses

Get Courses.

Inputs

Pagepagenumber
The page within the collection to fetch.At least 1. Default: 1.0.
Limitlimitnumber
The number of items to be returnedAt least 1. Default: 25.0.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "items": [],
    "meta": {
      "pagination": {
        "current_page": 1.0,
        "entries_info": "example",
        "next_page": 1.0,
        "prev_page": 1.0,
        "total_items": 1.0,
        "total_pages": 1.0
      }
    }
  }
}

List enrollments

Get Enrollments.

Inputs

Pagepagenumber
The page within the collection to fetch.At least 1. Default: 1.0.
Limitlimitnumber
The number of items to be returned.At least 1. Default: 25.0.
Learner IDperson_idnumber
Search Enrollments by User ID.
Coursecourse_idnumber
Search Enrollments by Course ID.
Emailemailtext
Search Enrollments by User email.
Free trialfree_trialtrue/false
Filter for only Free Trial Enrollments when set to true.
Fullfulltrue/false
Filter for only full Enrollments when set to true.
Completedcompletedtrue/false
Filter for only completed Enrollments when set to true.
Expiredexpiredtrue/false
Filter for only expired Enrollments when set to true.
Created oncreated_ondate
Filter for only Enrollments created on the date specified.
Created beforecreated_beforedate
Filter for only Enrollments created before the date specified.
Created on or beforecreated_on_or_beforedate
Filter for only Enrollments created on or before the date specified.
Created aftercreated_afterdate
Filter for only Enrollments created after the date specified.
Created on or aftercreated_on_or_afterdate
Filter for only Enrollments created on or after the date specified.
Updated onupdated_ondate
Filter for only Enrollments updated on the date specified.
Updated beforeupdated_beforedate
Filter for only Enrollments updated before the date specified.
Updated on or beforeupdated_on_or_beforedate
Filter for only Enrollments updated on or before the date specified.
Updated afterupdated_afterdate
Filter for only Enrollments updated after the date specified.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "items": [],
    "meta": {
      "pagination": {
        "current_page": 1.0,
        "entries_info": "example",
        "next_page": 1.0,
        "prev_page": 1.0,
        "total_items": 1.0,
        "total_pages": 1.0
      }
    }
  }
}

List groups

Get Groups.

Inputs

Pagepagenumber
The page within the collection to fetch.At least 1. Default: 1.0.
Limitlimitnumber
The number of items to be returned.At least 1. Default: 25.0.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "items": [],
    "meta": {
      "pagination": {
        "current_page": 1.0,
        "entries_info": "example",
        "next_page": 1.0,
        "prev_page": 1.0,
        "total_items": 1.0,
        "total_pages": 1.0
      }
    }
  }
}

List instructors

Get Instructors.

Inputs

Pagepagenumber
The page within the collection to fetch.At least 1. Default: 1.0.
Limitlimitnumber
The number of items to be returned.At least 1. Default: 25.0.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "items": [],
    "meta": {
      "pagination": {
        "current_page": 1.0,
        "entries_info": "example",
        "next_page": 1.0,
        "prev_page": 1.0,
        "total_items": 1.0,
        "total_pages": 1.0
      }
    }
  }
}

List orders

Get Orders.

Inputs

Pagepagenumber
The page within the collection to fetch.At least 1. Default: 1.0.
Limitlimitnumber
The number of items to be returned.At least 1. Default: 25.0.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "items": [],
    "meta": {
      "pagination": {
        "current_page": 1.0,
        "entries_info": "example",
        "next_page": 1.0,
        "prev_page": 1.0,
        "total_items": 1.0,
        "total_pages": 1.0
      }
    }
  }
}

List products

List products.

Inputs

Pagepagenumber
The page within the collection to fetchAt least 1. Default: 1.0.
Limitlimitnumber
The number of items to be returnedAt least 1. Default: 25.0.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "items": [],
    "meta": {
      "pagination": {
        "current_page": 1.0,
        "entries_info": "example",
        "next_page": 1.0,
        "prev_page": 1.0,
        "total_items": 1.0,
        "total_pages": 1.0
      }
    }
  }
}

List profile fields

Get Custom profile field definition.

Inputs

Pagepagenumber
The page within the collection to fetch.At least 1. Default: 1.0.
Limitlimitnumber
The number of items to be returned.At least 1. Default: 25.0.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "items": [],
    "meta": {
      "pagination": {
        "current_page": 1.0,
        "entries_info": "example",
        "next_page": 1.0,
        "prev_page": 1.0,
        "total_items": 1.0,
        "total_pages": 1.0
      }
    }
  }
}

List users

List Users.

Inputs

Pagepagenumber
The page within the collection to fetchAt least 1. Default: 1.0.
Limitlimitnumber
The number of items to be returnedAt least 1. Default: 25.0.
Emailemailtext
Search Users by email.
Roleroletext
Search Users by role.
External sourceexternal_sourcetext
Search Users by external source.
Custom profile field labelcustom_profile_field_labeltext
Search by custom profile field label (must be combined with custom_profile_field_value)
Custom profile field valuecustom_profile_field_valuetext
Search by custom profile field value (must be combined with custom_profile_field_label)
Groupgroup_idnumber
Search by group id.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {
    "items": [],
    "meta": {
      "pagination": {
        "current_page": 1.0,
        "entries_info": "example",
        "next_page": 1.0,
        "prev_page": 1.0,
        "total_items": 1.0,
        "total_pages": 1.0
      }
    }
  }
}

Update enrollment

Update enrollment.

Inputs

Enrollment IDidnumberRequired
ID of the Enrollment in the form of an integer.
Activated atactivated_atdate and time
The date/time at which the Enrollment is activated. If not provided, the Enrollment is a free trial.
Expiry dateexpiry_datedate and time
The date/time at which the Enrollment expired. If not provided, the Enrollment does not expire.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {}
}

Update user

Update user by ID.

Inputs

Learner IDidtextRequired
Accepts a Thinkific generated ID (in the form of an integer), or an External ID (as a string) when accompanied by the "provider" parameter.
Providerprovidertext
Provider from which the user's External Id is associated (Required if using External Id as id parameter)One of: SSO, OPENID_CONNECT (Openid connect).
First namefirst_nametext
User's first name
Last namelast_nametext
User's last name
Emailemailtext
User's email. This can only be updated by private integrations.
Passwordpasswordtext
The password of the User.
Rolesroleslist
User's rolesOne or more of: affiliate, course_admin (Course admin), group_analyst (Group analyst), site_admin (Site admin).
Avatar URLavatar_urltext
The fully-qualified avatar url of the User.
Biobiotext
User's bio
Companycompanytext
User's Company Name
Headlineheadlinetext
User's headline
External sourceexternal_sourcetext
User's external source
Affiliate codeaffiliate_codetext
User's affiliate code
Affiliate commissionaffiliate_commissionnumber
Required only if the User is an affiliate. This should be greater than 0 and less than or equal to 100 if the type is percentage or lower than 9999.99 if is a fixed type.
Affiliate commission typeaffiliate_commission_typetext
The affiliate payout type, it can be either % (percentage, default) or $ (fixed amount). Required only if the User is an affiliate.
Affiliate payout emailaffiliate_payout_emailtext
The email of the User. Required only if the user is an affiliate. Used to pay the User out.
Custom profile fieldscustom_profile_fieldslist
Custom profile fields for the User.

Outputs

dataobject
The result returned by Thinkific.
Example output
{
  "data": {}
}

On this page