Get a student action plan

GET

action-plan

k12

student

{ans_sheet_id}

Get a student action plan

curl --request GET \
  --url https://api.crazygoldfish.com/action-plan/v1/k12/student/{ans_sheet_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.crazygoldfish.com/action-plan/v1/k12/student/{ans_sheet_id}"

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/action-plan/v1/k12/student/{ans_sheet_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "4b7f2a91-6c3d-4e58-9a2b-7d1e0c5f8a34",
    "status": "In Progress",
    "student_id": "S-1042",
    "student_name": "Aarav Sharma",
    "created_at": "2026-09-17T11:31:02.884190",
    "action_plan": []
  }
}

Step 4 of 4 in Create action plans. Poll every 5 seconds until status is Completed or Partial.

Rules

ans_sheet_id is the same answer sheet ID you sent to Create a student action plan.
You only see plans that your own API user started. Use the same API user for both calls.
If you started the plan more than once for this answer sheet, you get the newest one.

Reading the response

Response	Meaning	What to do
`200` with `status: "In Progress"`	Still running. `action_plan` is an empty list.	Poll again
`200` with `status: "Completed"`	Ready. `action_plan` is a list with one item, the plan.	Show `action_plan[0]` to the student
`200` with `status: "Partial"`	Ready, but one or more questions are missing from `questions`	Use what came back, or start the plan again
`200` with `status: "Failed"`	The plan could not be written. `action_plan` holds one entry with an `error`.	Start the plan again
`400` `Invalid answer sheet ID format.`	`ans_sheet_id` is not a UUID	Fix the ID
`404` `Action plan not found for the given answer sheet ID.`	This API user has no plan for this answer sheet	Call the POST endpoint first
`500`	A server error. Check that the ID is an answer sheet ID you already used to create a plan, then retry.	Check the ID against the Exam Evaluation API, then retry

A plan’s status is one of In Progress, Completed, Partial, or Failed. Partial is a finished plan, not a running one, so treat it as ready and stop polling.

What the plan contains

Field	Meaning
`overall_insight`	What the student did well, and the one or two patterns that cost the most marks
`overall_action_type`	`Reinforcement`, `Remediation`, or `Extension` for the student overall
`action`	The two or three most important things to do next, in priority order
`skill_focus`	The single skill to work on most, in a few words
`confidence_booster_tip`	An encouraging line built on something the student did well in this exam
`questions`	One entry per question where the student lost marks, each with `question_number`, `action_type` and `action`

The plan is written to the student, in the language of the question paper. A question the student was allowed to skip is not in questions.

data.id is the action plan’s own ID, not the answer sheet ID. No endpoint takes it, so keep using the answer sheet ID.

Instead of polling, register a webhook for student_action_plan. See Async jobs and webhooks.

Create action plans

The full flow, from an evaluated exam to a plan for every student.

Authorizations

Authorization

string

header

required

Access token from Get an access token.

Path Parameters

ans_sheet_id

string<uuid>

required

The answer sheet ID from Create answer sheet, the same ID you send as ans_sheet_id to Create a student action plan.

Example:

"8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b"

Response

The plan exists. It is returned with HTTP 200 for every status, including Failed.

data

object

Show child attributes

Get a student action plan

curl --request GET \
  --url https://api.crazygoldfish.com/action-plan/v1/k12/student/{ans_sheet_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.crazygoldfish.com/action-plan/v1/k12/student/{ans_sheet_id}"

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/action-plan/v1/k12/student/{ans_sheet_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "4b7f2a91-6c3d-4e58-9a2b-7d1e0c5f8a34",
    "status": "In Progress",
    "student_id": "S-1042",
    "student_name": "Aarav Sharma",
    "created_at": "2026-09-17T11:31:02.884190",
    "action_plan": []
  }
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Get a student action plan

Rules

Reading the response

What the plan contains

Create action plans

Authorizations

Path Parameters

Response

​Rules

​Reading the response

​What the plan contains

​Related

Create action plans

Authorizations

Path Parameters

Response

Rules

Reading the response

What the plan contains

Related