# Thinkific

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

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/thinkific

## Actions

### Create enrollment

Create enrollment.

**Inputs**

- Course (`course_id`, number, required): The ID of the Course as an integer.
- Learner ID (`person_id`, number, required): The ID of the User owning the Enrollment as an integer.
- Activated at (`activated_at`, date and time): The date/time at which the Enrollment is activated. If not provided, the Enrollment is a free trial.
- Expiry date (`expiry_date`, date and time): The date/time at which the Enrollment expired. If not provided, the Enrollment does not expire.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Name (`name`, text, required): The name of the Group

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "data": {
    "created_at": "example",
    "id": 1.0,
    "name": "example",
    "token": "example"
  }
}
```

### Create user

Create user.

**Inputs**

- First name (`first_name`, text, required): User's first name
- Last name (`last_name`, text, required): User's last name
- Email (`email`, text, required): User's email
- Password (`password`, text): 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.
- Roles (`roles`, list): User's roles. One or more of: `affiliate`, `course_admin` (Course admin), `group_analyst` (Group analyst), `site_admin` (Site admin).
- Bio (`bio`, text): User's bio
- Company (`company`, text): User's Company Name
- Headline (`headline`, text): User's headline
- Affiliate code (`affiliate_code`, text): User's affiliate code
- Affiliate commission (`affiliate_commission`, number): 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 type (`affiliate_commission_type`, text): The affiliate payout type, it can be either % (percentage, default) or $ (fixed amount). Required only if the User is an affiliate.
- Affiliate payout email (`affiliate_payout_email`, text): The email of the User. Required only if the user is an affiliate. Used to pay the User out.
- Custom profile fields (`custom_profile_fields`, list): Custom profile fields for the User.
- Skip custom fields validation (`skip_custom_fields_validation`, true/false): Option to skip required custom profile fields validation. Default: `false`.
- Send welcome email (`send_welcome_email`, true/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 ID (`external_id`, text): 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)
- Provider (`provider`, text): 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**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Group (`id`, number, required): The ID of the Group in the form of an integer.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "data": {}
}
```

### Delete user

Delete user by ID.

**Inputs**

- Learner ID (`id`, text, required): Accepts a Thinkific generated ID (in the form of an integer), or an External ID (as a string) when accompanied by the "provider" parameter.
- Provider (`provider`, text): 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**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "data": {}
}
```

### Get course

Get courses by ID.

**Inputs**

- Course (`id`, number, required): ID of the Course in the form of an integer.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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 ID (`id`, number, required): ID of the Enrollment in the form of an integer.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Group (`id`, number, required): The ID of the Group to fetch.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "data": {
    "created_at": "example",
    "id": 1.0,
    "name": "example",
    "token": "example"
  }
}
```

### Get order

Get orders by ID.

**Inputs**

- Order ID (`id`, number, required): ID of the Orders in the form of an integer.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Product (`id`, number, required): Id of the product in the form of an integer

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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 ID (`id`, text, required): Accepts a Thinkific generated ID (in the form of an integer), or an External ID (as a string) when accompanied by the "provider" parameter.
- Provider (`provider`, text): 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**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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 ID (`id`, number, required): ID of the Chapter in the form of an integer
- Page (`page`, number): The page within the collection to fetch. At least 1. Default: `1.0`.
- Limit (`limit`, number): The number of items to be returned. At least 1. Default: `25.0`.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Product (`id`, number, required): ID of the Chapter in the form of an integer
- Page (`page`, number): The page within the collection to fetch. At least 1. Default: `1.0`.
- Limit (`limit`, number): The number of items to be returned. At least 1. Default: `25.0`.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Page (`page`, number): The page within the collection to fetch. At least 1. Default: `1.0`.
- Limit (`limit`, number): The number of items to be returned. At least 1. Default: `25.0`.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Course (`id`, number, required): ID of the Chapter in the form of an integer.
- Page (`page`, number): The page within the collection to fetch. At least 1. Default: `1.0`.
- Limit (`limit`, number): The number of items to be returned. At least 1. Default: `25.0`.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Page (`page`, number): The page within the collection to fetch. At least 1. Default: `1.0`.
- Limit (`limit`, number): The number of items to be returned. At least 1. Default: `25.0`.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Page (`page`, number): The page within the collection to fetch. At least 1. Default: `1.0`.
- Limit (`limit`, number): The number of items to be returned. At least 1. Default: `25.0`.
- Learner ID (`person_id`, number): Search Enrollments by User ID.
- Course (`course_id`, number): Search Enrollments by Course ID.
- Email (`email`, text): Search Enrollments by User email.
- Free trial (`free_trial`, true/false): Filter for only Free Trial Enrollments when set to true.
- Full (`full`, true/false): Filter for only full Enrollments when set to true.
- Completed (`completed`, true/false): Filter for only completed Enrollments when set to true.
- Expired (`expired`, true/false): Filter for only expired Enrollments when set to true.
- Created on (`created_on`, date): Filter for only Enrollments created on the date specified.
- Created before (`created_before`, date): Filter for only Enrollments created before the date specified.
- Created on or before (`created_on_or_before`, date): Filter for only Enrollments created on or before the date specified.
- Created after (`created_after`, date): Filter for only Enrollments created after the date specified.
- Created on or after (`created_on_or_after`, date): Filter for only Enrollments created on or after the date specified.
- Updated on (`updated_on`, date): Filter for only Enrollments updated on the date specified.
- Updated before (`updated_before`, date): Filter for only Enrollments updated before the date specified.
- Updated on or before (`updated_on_or_before`, date): Filter for only Enrollments updated on or before the date specified.
- Updated after (`updated_after`, date): Filter for only Enrollments updated after the date specified.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Page (`page`, number): The page within the collection to fetch. At least 1. Default: `1.0`.
- Limit (`limit`, number): The number of items to be returned. At least 1. Default: `25.0`.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Page (`page`, number): The page within the collection to fetch. At least 1. Default: `1.0`.
- Limit (`limit`, number): The number of items to be returned. At least 1. Default: `25.0`.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Page (`page`, number): The page within the collection to fetch. At least 1. Default: `1.0`.
- Limit (`limit`, number): The number of items to be returned. At least 1. Default: `25.0`.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Page (`page`, number): The page within the collection to fetch. At least 1. Default: `1.0`.
- Limit (`limit`, number): The number of items to be returned. At least 1. Default: `25.0`.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Page (`page`, number): The page within the collection to fetch. At least 1. Default: `1.0`.
- Limit (`limit`, number): The number of items to be returned. At least 1. Default: `25.0`.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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**

- Page (`page`, number): The page within the collection to fetch. At least 1. Default: `1.0`.
- Limit (`limit`, number): The number of items to be returned. At least 1. Default: `25.0`.
- Email (`email`, text): Search Users by email.
- Role (`role`, text): Search Users by role.
- External source (`external_source`, text): Search Users by external source.
- Custom profile field label (`custom_profile_field_label`, text): Search by custom profile field label (must be combined with custom_profile_field_value)
- Custom profile field value (`custom_profile_field_value`, text): Search by custom profile field value (must be combined with custom_profile_field_label)
- Group (`group_id`, number): Search by group id.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "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 ID (`id`, number, required): ID of the Enrollment in the form of an integer.
- Activated at (`activated_at`, date and time): The date/time at which the Enrollment is activated. If not provided, the Enrollment is a free trial.
- Expiry date (`expiry_date`, date and time): The date/time at which the Enrollment expired. If not provided, the Enrollment does not expire.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "data": {}
}
```

### Update user

Update user by ID.

**Inputs**

- Learner ID (`id`, text, required): Accepts a Thinkific generated ID (in the form of an integer), or an External ID (as a string) when accompanied by the "provider" parameter.
- Provider (`provider`, text): 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 name (`first_name`, text): User's first name
- Last name (`last_name`, text): User's last name
- Email (`email`, text): User's email. This can only be updated by private integrations.
- Password (`password`, text): The password of the User.
- Roles (`roles`, list): User's roles. One or more of: `affiliate`, `course_admin` (Course admin), `group_analyst` (Group analyst), `site_admin` (Site admin).
- Avatar URL (`avatar_url`, text): The fully-qualified avatar url of the User.
- Bio (`bio`, text): User's bio
- Company (`company`, text): User's Company Name
- Headline (`headline`, text): User's headline
- External source (`external_source`, text): User's external source
- Affiliate code (`affiliate_code`, text): User's affiliate code
- Affiliate commission (`affiliate_commission`, number): 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 type (`affiliate_commission_type`, text): The affiliate payout type, it can be either % (percentage, default) or $ (fixed amount). Required only if the User is an affiliate.
- Affiliate payout email (`affiliate_payout_email`, text): The email of the User. Required only if the user is an affiliate. Used to pay the User out.
- Custom profile fields (`custom_profile_fields`, list): Custom profile fields for the User.

**Outputs**

- `data` (object): The result returned by Thinkific.

**Example output**

```json
{
  "data": {}
}
```
