The Bookmarks API allows users to save channels for quick access. Bookmarks are per-user and help organize channels you frequently work with.
Endpoints
List Bookmarks
curl -H "Authorization: Token YOUR_TOKEN" \
https://studio.learningequality.org/api/bookmark
[
{
"id": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
"channel": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"channel_name": "Mathematics K-12",
"modified": "2024-01-15T10:30:00Z"
}
]
Add Bookmark
curl -X POST \
-H "Authorization: Token YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"channel": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"}' \
https://studio.learningequality.org/api/bookmark
{
"id": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
"channel": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"modified": "2024-01-15T10:30:00Z"
}
Remove Bookmark
curl -X DELETE \
-H "Authorization: Token YOUR_TOKEN" \
https://studio.learningequality.org/api/bookmark/b1c2d3e4-f5a6-7890-bcde-f12345678901
Use Cases
Quick Access Dashboard
Bookmarks allow users to create a personalized dashboard of frequently accessed channels:
- Pin channels you’re actively working on
- Quick access to channels you review regularly
- Organize channels across multiple projects
Filtering Channels
You can filter channels by bookmark status using the channels API:
curl -H "Authorization: Token YOUR_TOKEN" \
"https://studio.learningequality.org/api/channel?bookmark=true"
Bookmark Object
Unique identifier for the bookmark
ID of the bookmarked channel
Name of the bookmarked channel (read-only)
Timestamp when bookmark was last updated
Next Steps
Channels API
Manage channel content and metadata
Channel Sets
Organize channels into collections
