TeachableClient
Defined in: index.ts:20
The root client for interacting with the Teachable API. Instantiating this class automatically sets up all versioned sub-clients.
Example
Section titled “Example”import { TeachableClient } from './src';
const client = new TeachableClient('your-api-key');const users = await client.v1.users.getList();Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TeachableClient(
apiKey):TeachableClient
Defined in: index.ts:32
Creates a new TeachableClient instance and initialises the v1 sub-client.
Parameters
Section titled “Parameters”apiKey
Section titled “apiKey”string
Your Teachable API key, used to authenticate all requests.
Returns
Section titled “Returns”TeachableClient
Properties
Section titled “Properties”v1:
TeachableV1
Defined in: index.ts:26
Provides access to all Teachable v1 API resources, including users, transactions, and courses.