v1

latestOpenAPI 3.1.02026-08-0653126213.6 KB
Badge

Read Open Badge

Retrieve a badge using the Open Badges Schema.

get/v1/badge/{badge_id}/open_badges

Path parameters

badge_idinteger required

Headers

X-Access-Tokenstring nullable

Response

Successful Response

@contextstring
typestring
idstring
namestring
descriptionstring
tagsstring[] nullable

Example response

{
  "id": "https://navigatr.app/badge/12345/Learn-Your-ABCs",
  "name": "Learn Your ABCs",
  "description": "This badge is awarded to earners who have demonstrated their knowledge of all letters of the English alphabet."
}