Skip to main content
GET
/
badges
List badge definitions
curl --request GET \
  --url https://api.hixbe.com/certify/badges \
  --header 'Authorization: Bearer <token>' \
  --header 'Hixbe-Version: <hixbe-version>'
{
  "data": [
    {
      "id": "badge_1234567890abcdef",
      "name": "Excellence Award"
    },
    {
      "id": "badge_0987654321fedcba",
      "name": "Community Contributor"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Hixbe-Version
string
required

API version in YYYY-MM-DD format

Example:

"2026-01-01"

Response

Successfully retrieved badge definitions

Response containing a list of badge definitions

​
data
object[]

Array of badge definitions