Skip to main content
GET
List courses

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:30

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

title
string
status
string
status[]
string[]
type
string
type[]
string[]
order[dateCreated]
enum<string>
default:asc
Available options:
asc,
desc
order[position]
enum<string>
default:asc
Available options:
asc,
desc
order[title]
enum<string>
default:asc
Available options:
asc,
desc
dateCreated[before]
string
dateCreated[strictly_before]
string
dateCreated[after]
string
dateCreated[strictly_after]
string

Response

Course collection

id
integer
read-only
uuid
string | null
title
string
description
string | null
thumbnail
string | null
status
string
default:draft
type
string
default:self_paced
visibility
(string | null)[] | null
position
integer | null
default:0
studentsNumber
integer
default:0
dateCreated
string<date-time>
tags
object[]
roles
object[]
badge
object | null
totalLessons
integer
read-only
totalQuizzes
integer
read-only