GET /v1/blocks to retrieve your study blocks. You can filter by a specific date, a date range, a subject ID, or completion status. Without any filters, the endpoint returns all blocks.
Endpoint
Query Parameters
Filter blocks by an exact date. Must be in
YYYY-MM-DD format. Cannot be combined with date_from or date_to.Start of a date range filter. Must be in
YYYY-MM-DD format. Use together with date_to to define a range.End of a date range filter. Must be in
YYYY-MM-DD format. Use together with date_from to define a range.Filter blocks by a specific subject. Only blocks belonging to the given subject ID are returned.
Filter by completion status. Pass
true to return only completed blocks, or false to return only incomplete blocks.Response
Returns an array of block objects inside thedata field.
Unique identifier for the study block.
The ID of the subject this block belongs to.
The display name of the subject.
The date of the block in
YYYY-MM-DD format.The block’s start time in
HH:MM format.The block’s end time in
HH:MM format.An optional topic or syllabus item label attached to this block. May be
null.Whether the block has been marked as complete.
Examples
To fetch blocks for a single day, use the
date parameter rather than setting date_from and date_to to the same value.