Introduction

Introduction

CourseLit provides an API that allows you to manage your school programmatically. Start here to understand how to authenticate and prepare your integration.

You can also explore the interactive API Reference.

Prerequisites

Before you start, ensure you have the following:

1. A CourseLit account with admin privileges.
2. An API key for your domain. You can generate one from the dashboard.

Obtaining the API Key

To interact with the CourseLit API, you need an API key. Follow these steps to obtain your API key:

1. Log in to your CourseLit admin account.
2. Navigate to the dashboard.
3. Go to the Settings > Miscellaneous > API Keys section and generate a new API key.

API Key Actor

API keys are school-level credentials. They are not attached to an individual user account.

When CourseLit receives an API-key-authenticated request, it resolves the school owner for the current domain and uses that owner as the actor for permission checks and resource ownership. For example, resources created through the API use the same owner-backed context that the dashboard business logic expects.

Do not send userId, creatorId, or similar ownership fields in API requests unless a specific endpoint documents that field as part of the customer being managed.

Setting Up the Environment

Store your CourseLit server URL and API key securely in environment variables used by your application.

For endpoint details, request and response schemas, and example requests, use the API Reference.

Need Help?

If you encounter any issues or have questions, feel free to reach out to us on our Discord channel or send a tweet at @CourseLit.