Overview
Circulars allow schools to distribute official communications, announcements, and documents to teachers, parents, and other stakeholders. Each circular is a PDF document that can be targeted to specific audiences.List Circulars
Retrieve all circulars visible to the current user. Users withwrite:communications permission see all circulars; others see only circulars that have been sent and are addressed to them.
Query Parameters
Response
Create Circular
Create a new circular by uploading a PDF document. This endpoint uses multipart/form-data encoding.Request Body (multipart/form-data)
Get Circular
Retrieve details about a specific circular.Path Parameters
Get Circular Content
Download or view the PDF content of a circular.Path Parameters
Query Parameters
Response
Returns the PDF file with appropriate headers for viewing or downloading.List Recipients
Get a list of all recipients for a circular, including delivery and read status.Path Parameters
Response
Mark as Opened
Mark a circular as opened by the current user. This is typically called automatically when a user views a circular.Path Parameters
File Requirements
Permissions
Circular endpoints require the following permissions:write:communications- Create and manage circulars (admin)read:communications- View circulars addressed to the userread:all- View all circulars (admin)write:all- Full administrative access