Skip to main content

What you can do with the API​

  • Manage users and courses
  • Sync data with HRIS systems
  • Track course completion
  • Automate provisioning workflows

API key​

You'll need an API key to make requests. Generate it from your TalentLMS account settings and keep it private.

Authentication​

The TalentLMS API uses API key authentication via the X-API-Key header. See the introduction for more details and the Authentication section.

  • Send your API key in the X-API-Key request header with every request.

Example:

X-API-Key: your_api_key

Keep in mind​

  • Pagination: The pagination limit of each request is 100.
  • Rate limits: The API has rate and usage limits (e.g. 2000 requests per hour).
  • Response format: The API returns responses in JSON format. When a request returns an error, it is sent in the JSON response under an error key. All calls must include the header Accept: application/json.
  • API version: In each request you must specify the desired API version by adding the header X-API-Version with a value in the format YYYY-MM-DD.
  • Authentication: All requests require authentication. The API uses the API Key authorization method: add the header X-API-Key with the value your_api_key.

Your first request​

Start by calling a simple endpoint to confirm your setup (e.g. list users). Then continue with the API Reference for full endpoint details.