Skip to main content
GET
List badges

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

The number of items per page

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

Enable or disable pagination

type
string
type[]
string[]
name
string
order[id]
enum<string>
default:asc
Available options:
asc,
desc
exists[type]
boolean

Response

200 - application/json

Badge collection

name
string
required
id
integer
read-only
type
object | null
translation
string | null
logo
string | null
hours
integer | null
referrals
integer | null
defaultNote
string | null
pointsRequired
integer | null
level
integer | null
tierBenefits
(string | null)[] | null