GET - Boards

This API allows authenticated users to retrieve all boards.

How to Use:

Call GET /metadata/v1/board to get the list of all boards and their unique id values.
Use the id of the required board in lesson plans or any other feature that needs a board reference.

Example Scenario: A teacher wants to create or view a lesson plan for a specific board: - First, they call this API to list all boards and find the required board’s id. - Then, they use that id in the lesson plan API or anywhere else in the system where a board reference is needed.

GET

metadata

board

List Boards

curl --request GET \
  --url https://api-staging.crazygoldfish.com/metadata/v1/board \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "baf36573-d049-4636-9c4b-bc9cda6270fe",
    "name": "CBSE"
  }
]

Authorizations

Authorization

string

header

required

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

Response

A list of boards.

string

Unique identifier for the board.

name

string

Name of the board.

GET - Grades This API allows authenticated users to retrieve all grades for a specific board. **How to Use:** 1. Call `GET /metadata/v1/board/{board_id}/grades` with the required board's `id` to get the list of all grades for that board. 2. Use the `id` of the required grade in lesson plans or any other feature that needs a grade reference. **Example Scenario:** A teacher wants to create or view a lesson plan for a specific grade within a board: - First, they call the boards API to list all boards and find the required board's `id`. - Then, they call this API to list all grades for that board and find the required grade's `id`. - Finally, they use that grade `id` in the lesson plan API or anywhere else in the system where a grade reference is needed.

List Boards

curl --request GET \
  --url https://api-staging.crazygoldfish.com/metadata/v1/board \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "baf36573-d049-4636-9c4b-bc9cda6270fe",
    "name": "CBSE"
  }
]

Documentation Index

Authorizations

Response