BadgeListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe-captivate/refs/heads/main/json-schema/prime-api-badge-list-response-schema.json",
  "title": "BadgeListResponse",
  "description": "Paginated list of badges",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A badge awarded to learners for achievements",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique badge identifier"
          },
          "type": {
            "type": "string",
            "const": "badge"
          },
          "attributes": {
            "type": "object",
            "properties": {
              "imageUrl": {
                "type": "string",
                "format": "uri",
                "description": "URL of the badge image"
              },
              "name": {
                "type": "string",
                "description": "Badge name"
              },
              "state": {
                "type": "string",
                "description": "Badge state",
                "enum": [
                  "Active",
                  "Retired"
                ]
              }
            }
          }
        }
      }
    },
    "links": {
      "type": "object",
      "description": "Pagination links following JSON:API conventions",
      "properties": {
        "self": {
          "type": "string",
          "format": "uri",
          "description": "URL for the current page"
        },
        "next": {
          "type": "string",
          "format": "uri",
          "description": "URL for the next page"
        },
        "prev": {
          "type": "string",
          "format": "uri",
          "description": "URL for the previous page"
        }
      }
    }
  }
}