Skip to main content
GET
List badge checklist steps

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:200

The number of items per page

Required range: 0 <= x <= 100
badge
string
badge[]
string[]
isArchived
boolean
order[position]
enum<string>
default:asc
Available options:
asc,
desc
order[id]
enum<string>
default:asc
Available options:
asc,
desc

Response

200 - application/json

BadgeStep collection

id
integer
read-only
badge
string<iri-reference>
Example:

"/api/v1/badges/1"

position
integer
default:1
title
string
description
string | null
translation
string | null
isOptional
boolean
default:false
isArchived
boolean
default:false
dateCreated
string<date-time>
read-only
dateUpdated
string<date-time> | null
read-only