Is there a parent action plan API?
No. The action plan service has four operations in total: start a student plan, read a student plan, start a teacher plan, read a teacher plan. There is no parent request, no parent plan format, and no parent event to subscribe to. You can see everything the API offers on the API overview.What can a school share with families today?
The student action plan is the closest thing available. It is written in plain language and covers one student’s paper.
The plan also returns the student ID and name recorded on the answer sheet, so your platform can file it against the right family. Two things to keep in mind: the advice is addressed to the student, not to a parent, and it is written in English only.
What is not available
These are not part of the API:
There is one parent-shaped field in the platform. When you upload an answer sheet you can record a
parentId of your own against it, and it is stored and returned to you with the answer sheet. Nothing reads it: no plan, message, or report is produced from it. It is a label for your own records.
Frequently asked questions
Can I request a parent action plan through the API?
Can I request a parent action plan through the API?
No. There is no endpoint for it. Requests exist only for student plans and teacher plans.
Is there a webhook that tells me a parent plan is ready?
Is there a webhook that tells me a parent plan is ready?
No. The two action plan events you can register are
student_action_plan and teacher_action_plan.Can the API message parents directly?
Can the API message parents directly?
No. The API has no messaging of any kind. It stores a plan and returns it when you ask for it. Anything a family sees is sent by your own platform.
What is the most parent-friendly thing I can show today?
What is the most parent-friendly thing I can show today?
A student action plan. Your platform can show its summary, its advice, and its confidence tip to a family, and leave out anything written for staff. The teacher plan is not suitable, because it names other students.
Who decides whether a family sees a plan?
Who decides whether a family sees a plan?
You do. The API returns a plan to the API user that created it and applies no rules of its own about who may see it. There are no roles in CrazyGoldFish, so which of your users can read, share, or send a plan is decided entirely in your platform.
Will a parent action plan be added?
Will a parent action plan be added?
That is a product decision, not something the documentation can answer. Contact CrazyGoldFish to ask about it or to describe what you need.
Next steps
Student action plans
The plan that exists today, and what it contains.
Developer guide
Create student and teacher action plans with the API, step by step.