> ## Documentation Index
> Fetch the complete documentation index at: https://docs.schoolmaker.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Badges

> Retrieves badges, newest first. Returns up to 30 badges per page.



## OpenAPI

````yaml get /badges
openapi: 3.0.1
info:
  title: SchoolMaker API V1
  description: API for managing your SchoolMaker school
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://schoolmaker.co/api/v1
    description: Production API
security:
  - bearerAuth: []
paths:
  /badges:
    get:
      tags:
        - Badges
      summary: List Badges
      description: Retrieves badges, newest first. Returns up to 30 badges per page.
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 10000
            default: 1
        - name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 30
            default: 30
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - page
                  - next_page
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - name
                        - image_type
                        - emoji
                        - image_url
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        image_type:
                          type: string
                          enum:
                            - emoji
                            - upload
                            - ai
                        emoji:
                          type: string
                          nullable: true
                        image_url:
                          type: string
                          nullable: true
                          description: >-
                            Saved badge image URL, including when emoji mode is
                            selected.
                  page:
                    type: integer
                  next_page:
                    type: integer
                    nullable: true
              example:
                data:
                  - id: BADGE_ID
                    name: First milestone
                    image_type: emoji
                    emoji: 🏆
                    image_url: null
                page: 1
                next_page: null
        '401':
          description: Missing or invalid API credentials, or unavailable school account.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    oneOf:
                      - type: string
                      - type: array
                        items:
                          type: string
              example:
                error: Access denied
        '422':
          description: Invalid badge details.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    oneOf:
                      - type: string
                      - type: array
                        items:
                          type: string
              example:
                error: 'Invalid arguments: /attributes/name minLength'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.