Documentation Kenii Catalog Reference
REST API
All REST routes in this module with their methods and required permissions.
REST API
Generated from code at version 3.18.5. Do not edit by hand; run the reference generator to refresh.
All routes are under the kenii/v1 namespace. Admin routes require a signed-in staff session (kenii_manage_catalog or manage_options). Public API routes read with an API key.
Example
Read the public catalog with an API key:
curl -H "X-Kenii-API-Key: YOUR_KEY"
https://your-college.edu/wp-json/kenii/v1/api/programs
Total routes: 176.
Admin routes (authenticated staff, gated by kenii_manage_catalog or manage_options)
| Route | Methods | Permission |
|---|---|---|
/kenii/v1/admin/academic-year/create |
POST | (default) |
/kenii/v1/admin/account/password |
POST | (default) |
/kenii/v1/admin/account/profile |
GET POST | (default) |
/kenii/v1/admin/addenda/(?P<id>d+) |
PUT DEL | (default) |
/kenii/v1/admin/alert |
GET POST | kenii_api_directory_permission_check |
/kenii/v1/admin/announcement |
GET POST | kenii_api_directory_permission_check |
/kenii/v1/admin/api-keys |
GET POST | (default) |
/kenii/v1/admin/api-keys/(?P<prefix>[a-zA-Z0-9_]+) |
DEL | (default) |
/kenii/v1/admin/archive-settings |
GET POST | (default) |
/kenii/v1/admin/archive-settings/(?P<post_type>[a-z0-9_]+)/taxonomies |
GET | (default) |
/kenii/v1/admin/articulations |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/articulations/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/articulations/import |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/articulations/import-csv |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/audit-log |
GET | (default) |
/kenii/v1/admin/audit-log/recent |
GET | (default) |
/kenii/v1/admin/available-logins |
GET | kenii_api_directory_permission_check |
/kenii/v1/admin/board/bodies |
GET | kenii_api_board_permission_check |
/kenii/v1/admin/board/bodies/(?P<id>d+) |
GET POST | kenii_api_board_permission_check |
/kenii/v1/admin/board/bodies/(?P<id>d+)/roster |
GET | kenii_api_board_permission_check |
/kenii/v1/admin/board/documents |
GET POST | kenii_api_board_permission_check |
/kenii/v1/admin/board/documents/(?P<id>d+) |
POST DEL | kenii_api_board_permission_check |
/kenii/v1/admin/board/documents/(?P<id>d+)/replace |
POST | kenii_api_board_permission_check |
/kenii/v1/admin/board/import/commit |
POST | kenii_api_board_permission_check |
/kenii/v1/admin/board/import/preview |
POST | kenii_api_board_permission_check |
/kenii/v1/admin/board/motions |
POST | kenii_api_board_permission_check |
/kenii/v1/admin/board/motions/(?P<id>d+) |
POST DEL | kenii_api_board_permission_check |
/kenii/v1/admin/board/settings |
GET POST | kenii_api_board_permission_check |
/kenii/v1/admin/board/year-build |
POST | kenii_api_board_permission_check |
/kenii/v1/admin/board/year-preview |
POST | kenii_api_board_permission_check |
/kenii/v1/admin/calendar-years/pdfs |
GET POST | (default) |
/kenii/v1/admin/campuses |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/campuses/(?P<id>d+) |
GET POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/catalog-years |
GET POST | kenii_api_view_permission_check |
/kenii/v1/admin/catalog-years/(?P<id>d+) |
POST DEL | (default) |
/kenii/v1/admin/catalog-years/(?P<id>d+)/calendar-pdf |
POST | (default) |
/kenii/v1/admin/catalog-years/(?P<id>d+)/clone |
POST | (default) |
/kenii/v1/admin/catalog-years/(?P<id>d+)/docx |
GET | kenii_api_admin_permission_check |
/kenii/v1/admin/catalog-years/(?P<id>d+)/generate-docx |
POST | kenii_api_admin_permission_check |
/kenii/v1/admin/catalog-years/(?P<id>d+)/html-archive |
GET POST | kenii_api_admin_permission_check |
/kenii/v1/admin/catalog-years/(?P<id>d+)/lock |
POST | (default) |
/kenii/v1/admin/catalog-years/(?P<id>d+)/pdf |
GET | kenii_api_admin_permission_check |
/kenii/v1/admin/catalog-years/(?P<id>d+)/regenerate-pdf |
POST | kenii_api_admin_permission_check |
/kenii/v1/admin/catalog-years/(?P<id>d+)/sections |
GET | kenii_api_admin_permission_check |
/kenii/v1/admin/catalog-years/(?P<id>d+)/visibility |
POST | (default) |
/kenii/v1/admin/catalog-years/(?P<year_id>d+)/addenda |
GET POST | (default) |
/kenii/v1/admin/catalog-years/diff |
GET | kenii_api_view_permission_check |
/kenii/v1/admin/catalog-years/set-active |
POST | (default) |
/kenii/v1/admin/clear-cache |
POST | (default) |
/kenii/v1/admin/convert-credential-to-course |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/course-attributes |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/course-attributes/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/course-prefixes |
GET | kenii_admin_session_permission_check |
/kenii/v1/admin/course-prefixes/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/course-usage/(?P<id>d+) |
GET | (default) |
/kenii/v1/admin/courses |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/courses/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/create-pages |
POST | kenii_api_admin_permission_check |
/kenii/v1/admin/credential-types |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/credential-types/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/credentials |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/credentials/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/credentials/(?P<id>d+)/detach |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/credentials/(?P<id>d+)/preview |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/data-health |
GET | kenii_admin_session_permission_check |
/kenii/v1/admin/data-health/recheck |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/delivery-modes |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/delivery-modes/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/groups |
GET POST | kenii_api_groups_permission_check |
/kenii/v1/admin/groups/(?P<id>d+) |
GET POST DEL | kenii_api_groups_permission_check |
/kenii/v1/admin/handbook |
GET POST | (default) |
/kenii/v1/admin/handbook/(?P<id>d+) |
POST DEL | (default) |
/kenii/v1/admin/handbook/(?P<id>d+)/extract |
POST | (default) |
/kenii/v1/admin/handbook/clone |
POST | (default) |
/kenii/v1/admin/handbook/reorder |
POST | (default) |
/kenii/v1/admin/handbook/restructure |
POST | kenii_api_admin_permission_check |
/kenii/v1/admin/handbook/rollback |
POST | kenii_api_admin_permission_check |
/kenii/v1/admin/import/courses/preview |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/import/runs |
GET | kenii_admin_session_permission_check |
/kenii/v1/admin/import/runs/(?P<id>d+) |
GET | kenii_admin_session_permission_check |
/kenii/v1/admin/import/runs/(?P<id>d+)/apply |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/import/runs/(?P<id>d+)/changes |
GET | kenii_admin_session_permission_check |
/kenii/v1/admin/import/runs/(?P<id>d+)/decide |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/import/runs/(?P<id>d+)/discard |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/invite-roles |
GET | (default) |
/kenii/v1/admin/license |
GET | kenii_license_rest_permission |
/kenii/v1/admin/license/account |
GET | kenii_license_rest_permission |
/kenii/v1/admin/license/portal |
POST | kenii_license_rest_permission |
/kenii/v1/admin/license/verify |
POST | kenii_license_rest_permission |
/kenii/v1/admin/my-work |
GET | kenii_api_curriculum_permission_check |
/kenii/v1/admin/notifications |
GET | (default) |
/kenii/v1/admin/notifications/read |
POST | (default) |
/kenii/v1/admin/notify-prefs |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/offerings |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/offerings/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/pages |
GET | kenii_api_directory_permission_check |
/kenii/v1/admin/people |
GET POST | kenii_api_directory_permission_check |
/kenii/v1/admin/people-groupings |
GET POST | kenii_api_directory_permission_check |
/kenii/v1/admin/people-groupings/(?P<taxonomy>[a-z_]+)/(?P<id>d+) |
POST DEL | kenii_api_directory_permission_check |
/kenii/v1/admin/people/(?P<id>d+) |
GET POST DEL | kenii_api_directory_permission_check |
/kenii/v1/admin/people/(?P<id>d+)/invite |
POST | (default) |
/kenii/v1/admin/policies |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/policies/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/program-areas |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/program-areas/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/program-types |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/program-types/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/rebuild-junction |
POST | (default) |
/kenii/v1/admin/reports |
GET POST | kenii_can_manage_catalog |
/kenii/v1/admin/reports/(?P<id>d+) |
POST DEL | kenii_can_manage_catalog |
/kenii/v1/admin/reports/(?P<id>d+)/file |
GET | kenii_can_manage_catalog |
/kenii/v1/admin/reports/(?P<id>d+)/generate |
POST | kenii_can_manage_catalog |
/kenii/v1/admin/reports/preview |
POST | kenii_can_manage_catalog |
/kenii/v1/admin/requirement-blocks |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/requirement-blocks/(?P<id>d+) |
GET POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/requirement-blocks/(?P<id>d+)/usage |
GET | kenii_api_view_permission_check |
/kenii/v1/admin/roles |
GET POST | kenii_api_directory_permission_check |
/kenii/v1/admin/roles/(?P<id>d+) |
GET POST DEL | kenii_api_directory_permission_check |
/kenii/v1/admin/setup |
GET POST | kenii_setup_permission |
/kenii/v1/admin/setup/migrator-install |
POST | kenii_setup_permission |
/kenii/v1/admin/signals |
GET | kenii_can_manage_catalog |
/kenii/v1/admin/signals/community-report |
GET | kenii_can_manage_catalog |
/kenii/v1/admin/signals/delete-all |
POST | kenii_can_manage_catalog |
/kenii/v1/admin/site-pages |
GET | kenii_api_view_permission_check |
/kenii/v1/admin/support |
POST | kenii_support_permission_check |
/kenii/v1/admin/team |
GET POST | (default) |
/kenii/v1/admin/team/(?P<id>d+) |
DEL | (default) |
/kenii/v1/admin/team/(?P<id>d+)/level |
POST | (default) |
/kenii/v1/admin/team/(?P<id>d+)/person |
POST | (default) |
/kenii/v1/admin/team/(?P<id>d+)/resend |
POST | (default) |
/kenii/v1/admin/terms |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/terms/(?P<id>d+) |
GET POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/terms/(?P<id>d+)/clone-dates |
POST | (default) |
/kenii/v1/admin/terms/(?P<id>d+)/cloneable-sources |
GET | (default) |
/kenii/v1/admin/testimonials |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/testimonials/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/trash |
GET | kenii_admin_session_permission_check |
/kenii/v1/admin/trash/(?P<id>d+) |
DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/trash/(?P<id>d+)/restore |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/year/(?P<id>d+)/archive |
POST | kenii_api_admin_permission_check |
Public API routes (read via API key; writes require manage_options)
| Route | Methods | Permission |
|---|---|---|
/kenii/v1/api/academic-year/create |
POST | (default) |
/kenii/v1/api/addenda |
GET | kenii_api_permission_check |
/kenii/v1/api/articulations |
GET | kenii_api_permission_check |
/kenii/v1/api/audit-log |
GET | kenii_api_admin_permission_check |
/kenii/v1/api/audit-log/recent |
GET | kenii_api_admin_permission_check |
/kenii/v1/api/catalog-years |
GET POST | kenii_api_admin_permission_check |
/kenii/v1/api/catalog-years/(?P<id>d+)/calendar-pdf |
POST | (default) |
/kenii/v1/api/catalog-years/(?P<id>d+)/clone |
POST | kenii_api_admin_permission_check |
/kenii/v1/api/catalog-years/(?P<id>d+)/lock |
POST | kenii_api_admin_permission_check |
/kenii/v1/api/catalog-years/(?P<id>d+)/visibility |
POST | kenii_api_admin_permission_check |
/kenii/v1/api/catalog-years/set-active |
POST | kenii_api_admin_permission_check |
/kenii/v1/api/courses |
GET POST | kenii_api_admin_permission_check |
/kenii/v1/api/courses/(?P<id>d+) |
POST DEL | kenii_api_admin_permission_check |
/kenii/v1/api/credentials |
GET POST | kenii_api_admin_permission_check |
/kenii/v1/api/credentials/(?P<id>d+) |
POST DEL | kenii_api_admin_permission_check |
/kenii/v1/api/credentials/(?P<id>d+)/pdf |
GET | __return_true |
/kenii/v1/api/dashboard |
GET | kenii_api_permission_check |
/kenii/v1/api/export |
GET | kenii_api_permission_check |
/kenii/v1/api/programs |
GET POST | kenii_api_admin_permission_check |
/kenii/v1/api/programs/(?P<id>d+) |
POST DEL | kenii_api_admin_permission_check |
/kenii/v1/api/progress-check |
POST | __return_true |
/kenii/v1/api/settings |
GET | kenii_api_permission_check |
/kenii/v1/api/terms |
GET POST | kenii_api_admin_permission_check |
/kenii/v1/api/terms/(?P<id>d+) |
GET POST DEL | kenii_api_admin_permission_check |
/kenii/v1/api/terms/(?P<id>d+)/clone-dates |
POST | kenii_api_admin_permission_check |
/kenii/v1/api/terms/(?P<id>d+)/cloneable-sources |
GET | kenii_api_permission_check |
Other routes
| Route | Methods | Permission |
|---|---|---|
/kenii/v1 |
GET | public |
/kenii/v1/admin |
GET | public |
/kenii/v1/breadcrumb/(?P<id>d+) |
GET | __return_true |
/kenii/v1/catalog-pdf/(?P<id>d+) |
GET | __return_true |
/kenii/v1/catalog-pdf/active |
GET | __return_true |
/kenii/v1/credential/(?P<id>d+)/data |
GET | __return_true |
/kenii/v1/credential/(?P<id>d+)/requirements |
GET | __return_true |
/kenii/v1/document/(?P<id>d+)/download |
GET | kenii_document_download_permission |
/kenii/v1/program/(?P<id>d+)/data |
GET | __return_true |
/kenii/v1/signal |
POST | __return_true |