List assignments

GET

assignment-evaluation

assignment

List assignments

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

import requests

url = "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/"

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

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

print(response.text)

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

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

{
  "count": 12,
  "pageSize": 10,
  "showing": "Page 1 of 2",
  "next": "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/?page=2",
  "previous": null,
  "data": [
    {
      "id": "3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d",
      "assignmentName": "Unit 3 English essay",
      "status": 2,
      "grade": "7",
      "marks": 2,
      "section": "A",
      "parentInstituteId": "100",
      "instituteId": "200",
      "courseId": "300",
      "documents": [
        {
          "id": "bec0d0bf-fff6-40de-9750-65f5dcaf470d",
          "status": 2,
          "pageNo": null,
          "uploadTime": "2025-04-06T09:04:11.716434Z",
          "url": "https://<storage-host>/documents/assignment-evaluation/unit-3-question-paper.pdf",
          "fileType": 1,
          "audio_link": null
        }
      ],
      "createdAt": "2025-04-06T09:03:42.099207Z",
      "modifiedAt": "2025-04-06T09:06:19.351379Z"
    }
  ]
}

The list only includes assignments created with the same API user as your access token. Results are newest first.

Filters

Parameter	Matches
`assignmentName`	Part of the name, ignoring case
`grade`	Exact match
`section`	Exact match
`page`, `page_size`	Pagination, up to 1000 rows per page

curl "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/?grade=7&page_size=25" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

pageSize in the response is always 10, even when you send a different page_size. Count the rows in data to see the real page size, and use count, next, and previous to page through the list.

Get an assignment

One assignment with its documents and status.

List assignment answer sheets

Every student submission on one assignment.

Authorizations

Authorization

string

header

required

Access token from Get an access token.

Query Parameters

assignmentName

string

Match part of the assignment name, ignoring case.

Example:

"essay"

grade

string

Exact match on grade.

Example:

"7"

section

string

Exact match on section.

Example:

"A"

page

integer

default:1

Page number, starting at 1.

Required range: x >= 1

Example:

1

page_size

integer

default:10

Rows per page, up to 1000.

Required range: 1 <= x <= 1000

Example:

25

Response

One page of assignments.

count

integer

Total number of rows that match, across all pages.

Example:

12

pageSize

integer

Always 10, even when you send a different page_size. Count data to see the real page size.

Example:

10

showing

string

Which page you are on.

Example:

"Page 1 of 2"

string<uri> | null

URL of the next page, or null on the last page.

Example:

"https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/?page=2"

string<uri> | null

URL of the previous page, or null on the first page.

Example:

null

data

object[]

Show child attributes

List assignments

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

import requests

url = "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/"

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

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

print(response.text)

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

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

{
  "count": 12,
  "pageSize": 10,
  "showing": "Page 1 of 2",
  "next": "https://api.crazygoldfish.com/assignment-evaluation/v1/assignment/?page=2",
  "previous": null,
  "data": [
    {
      "id": "3c9e1f2a-7b4d-4a8e-9f1c-2d5e6a7b8c9d",
      "assignmentName": "Unit 3 English essay",
      "status": 2,
      "grade": "7",
      "marks": 2,
      "section": "A",
      "parentInstituteId": "100",
      "instituteId": "200",
      "courseId": "300",
      "documents": [
        {
          "id": "bec0d0bf-fff6-40de-9750-65f5dcaf470d",
          "status": 2,
          "pageNo": null,
          "uploadTime": "2025-04-06T09:04:11.716434Z",
          "url": "https://<storage-host>/documents/assignment-evaluation/unit-3-question-paper.pdf",
          "fileType": 1,
          "audio_link": null
        }
      ],
      "createdAt": "2025-04-06T09:03:42.099207Z",
      "modifiedAt": "2025-04-06T09:06:19.351379Z"
    }
  ]
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Filters

Get an assignment

List assignment answer sheets

Authorizations

Query Parameters

Response

​Filters

​Related

Get an assignment

List assignment answer sheets

Authorizations

Query Parameters

Response

Filters

Related