GET - Extracted Assignment Question

This API allows authenticated users to retrieve a paginated list of assignments along with associated metadata like total count, pagination links, and assignment details.

Key Notes:

The response includes count, pageSize, showing, next, and previous to handle pagination.
The data field contains an array of assignment objects following the UpdatedAssignmentResponse schema.
Useful for dashboards or any view where a user needs to browse or manage multiple assignments.

Scenario: Fetching Assignments for Review

A teacher wants to review all assignments created for Grade 7.
They send a GET request to this endpoint (optionally with query parameters for filtering/pagination).
The system responds with a paginated list of assignments and relevant navigation links.

Want to receive automatic notifications when assignment questions are processed? Set up webhooks to get real-time updates on assignment questions extraction. Check out the Webhooks.

GET

assignment-evaluation

assignment

{id}

questions

Get Assignment Questions

curl --request GET \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/questions/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/questions/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/questions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/questions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/questions/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/questions/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "2600413f-7c6e-46ef-8ea9-3e7b5834879f",
  "assignmentName": "English Assignment",
  "instruction": "Write a short story about a day in the life of a cat.",
  "marks": 0,
  "grade": "7",
  "courseId": "300",
  "parentQuestions": [
    {
      "id": "b3098d35-50b4-4417-954f-0b9df6553bd4",
      "questionNumber": "Q1",
      "text": "Add olfactory imagery to the following:",
      "marks": 0,
      "questions": [
        {
          "id": "246b66a3-42b3-4f25-bb52-fe03475ef0c9",
          "questionNumber": "1",
          "text": "A flower shop",
          "marks": 0,
          "diagramDescription": "No diagram or image provided."
        }
      ]
    }
  ]
}

{
  "error": {
    "code": 400,
    "message": {
      "non_field_errors": [
        "Assignment is not extracted yet"
      ]
    }
  }
}

{
  "detail": "Token has expired"
}

{
  "error": {
    "code": 404,
    "message": {
      "non_field_errors": [
        "Assignment not found"
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Unique identifier of the assignment

Response

Assignment retrieved successfully.

string

Unique identifier for the assignment

Example:

"2600413f-7c6e-46ef-8ea9-3e7b5834879f"

assignmentName

string

Name of the assignment

Example:

"English Assignment"

instruction

string

Instructions for the assignment

Example:

"Write a short story about a day in the life of a cat."

marks

number<float>

Total marks for the assignment

Example:

0

grade

string

Grade of the assignment

Example:

"7"

courseId

string

ID of the course

Example:

"300"

parentQuestions

object[]

List of parent questions in the assignment

Show child attributes

Get Assignment Questions

curl --request GET \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/questions/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/questions/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/questions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/questions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/questions/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/questions/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "2600413f-7c6e-46ef-8ea9-3e7b5834879f",
  "assignmentName": "English Assignment",
  "instruction": "Write a short story about a day in the life of a cat.",
  "marks": 0,
  "grade": "7",
  "courseId": "300",
  "parentQuestions": [
    {
      "id": "b3098d35-50b4-4417-954f-0b9df6553bd4",
      "questionNumber": "Q1",
      "text": "Add olfactory imagery to the following:",
      "marks": 0,
      "questions": [
        {
          "id": "246b66a3-42b3-4f25-bb52-fe03475ef0c9",
          "questionNumber": "1",
          "text": "A flower shop",
          "marks": 0,
          "diagramDescription": "No diagram or image provided."
        }
      ]
    }
  ]
}

{
  "error": {
    "code": 400,
    "message": {
      "non_field_errors": [
        "Assignment is not extracted yet"
      ]
    }
  }
}

{
  "detail": "Token has expired"
}

{
  "error": {
    "code": 404,
    "message": {
      "non_field_errors": [
        "Assignment not found"
      ]
    }
  }
}

Overview

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

GET - Extracted Assignment Question

Authorizations

Path Parameters

Response