Skip to main content
Use the LearnInk API to power WebView single sign-on and manage user lifecycle actions from your systems.

​
In this API reference

The API reference pages in this section are auto-generated from our OpenAPI specification and include:
  • Request/response schemas
  • Required headers and parameters
  • Example payloads and error responses

​
Authentication

All API requests are authenticated using a Bearer API key. You can generate and rotate API keys in the LearnInk admin portal: Settings → Developers → API Keys LearnInk admin portal API Keys page showing the Generate key button. If your organisation doesn’t have access to this feature, contact support@learn.ink.

​
Request conventions

Most endpoints accept and return JSON.
  • Auth header: Authorization: Bearer <API_KEY>
  • Content type: Content-Type: application/json (for JSON request bodies)
Keep your API key server-side. Do not embed it in mobile apps or other client-side code.

​
Error handling

Error responses return a JSON body with a code and a human-readable message. Use the HTTP status code to drive your retry and user-facing behaviour, and log the full response for debugging. All endpoints are served from: https://my.learn.ink