Skip to content
Mindtickle Developer DocsBeta

Try searching for

↑↓ to navigate↵ to openesc to close
Dark mode

Getting started

Introduces the Mindtickle API families and the standards for its standard REST APIs, including base URLs, authentication, rate limits, and status codes.

View as Markdown(opens in a new tab)
Use with AI

Open this page in

ChatGPT(opens in a new tab)Claude(opens in a new tab)Cursor(opens in a new tab)

Mindtickle offers a set of public REST APIs that let you interact programmatically with the platform to automate tasks, integrate with external systems, and manage data. This category maps the API families and introduces the technical standards for the standard REST APIs. Follow the separate access guidance for Call AI and Reporting.

Prerequisites and shared context

Section titled “Prerequisites and shared context”
  • Credentials: An API key, a secret key, and your learning site URL, available in the Mindtickle admin site. See Authentication.
  • Access token: Exchange your credentials for a Bearer token at POST /services/data/auth_token, then send it in the Authorization header of every request. Tokens are typically valid for 60 minutes; use the expiration information returned by the authentication endpoint.
  • Base URL: The standard host or the API3 host, depending on the API and the region that hosts your account. See Base URLs.
  • Data format: JSON for request bodies and responses, with UTF-8 character support.
  • Rate limits and status codes: Platform defaults and API-specific exceptions. See Rate limits and Status codes.

In this category

Section titled “In this category”
  • API overview: the Mindtickle API families and what each one does.
  • Authentication and setup: base URLs, authentication, data format, rate limits, and status codes for the public REST APIs.