TIS Training API Documentation
  • Welcome!
  • Quick Start
  • Managing Users
  • Single Sign On (SSO)
    • General Options
    • Role and Group Mappings
    • Connection Types
      • Microsoft Entra ID (Formerly Azure AD)
      • Google Workspace
      • OpenID Connect (OIDC)
      • SAML (Security Assertion Markup Language)
  • SCORM Packages
  • Webhooks
  • API Reference
    • Users
      • 🔵GET users
      • 🔵GET users/seats
      • 🟢POST users
      • 🟠PUT users
      • 🟢POST users/password
      • 🟡PATCH users/enable
      • 🟡PATCH users/disable
      • 🔴DELETE users
    • Results
      • 🔵GET results
      • 🔵GET results/group
    • Groups
      • 🔵GET groups
      • 🟢POST groups/users
      • 🔴DELETE groups/users
    • 🔵GET courses
    • 🔵GET filters
    • 🟢POST login
    • â›”Standard Error Format
  • Webhook Reference
    • Standard Structure
    • Course Complete
    • Multi-Course Complete
  • OpenAPI Specification
Powered by GitBook
On this page
  • Authenticating Requests
  • Request and Response Format
  • Make your first request

Quick Start

PreviousWelcome!NextManaging Users

Last updated 7 months ago

Authenticating Requests

Requests to the API are authenticated using a Bearer token header, the token being your API key.

Request and Response Format

Requests with a body must be formatted using JSON. Responses with content will be in JSON.

Make your first request

Before we start, lets set our API Key as a variable in our Shell session.

APIKey={Your API Key}

To make your first request, send an authenticated request to the courses endpoint. This will list all of courses available to your organisation.

See below for an example of how to perform this call using curl:

curl https://training.tapintosafety.com.au/api/v2/courses \
    -H "Authorization: Bearer $APIKey"

That was a big list! Let's narrow it down a little.

curl https://training.tapintosafety.com.au/api/v2/courses \
    -G -d "categoryType=safety-training" -d "name=Safety" \
    -H "Authorization: Bearer $APIKey"

Much easier to read. At the time of writing this request returned just one course, however our library is updating all the time, so maybe you got a few more!

🔵GET courses