Skip to content

[API] Home Page Data #39068

Open

Description

@FuaadZam

Functional Area: Home Page Data

Endpoints under this functional area:

Module API Version Resource / Endpoint HTTP Method Description
Home v1 /contentstore/v1/home GET Retrieves the full home page object including courses, libraries, organization permissions, user course creator status, and studio/platform metadata. Supports optional org query parameter to filter by organization. Useful for AI dashboards, external admin tools, or automated course/library analysis.

Activity

  1. added theissue type on Sep 2, 2026
  2. Faraz32123 commented on Oct 26, 2026

    @Faraz32123
    Contributor

    Writing down what's left on the home page replacement before GET /api/contentstore/v1/home can be deprecated (#39263, waiting on the fix below):

    1. Write on GET. GET /api/authoring/v3/home/ (and v1) inserted a CourseCreator row for a non-staff user without one when ENABLE_CREATOR_GROUP is on (_get_course_creator_status → add_user_with_status_unrequested). Fix: report unrequested when there's no row, and create it in user_requested_access with get_or_create when the user asks for access.
    2. org does nothing. The v3 home list action documented an org query parameter, but get_home_context(request, True) never loads courses, so it was ignored. Removed from the schema.
    3. Public. v1 home is published without x-internal, so its replacement should be too. x-internal came from feat: apply ADR 0038 (URL structure standardization) across 6 standardized APIs #39078 treating home as a BFF; ADR 0038 allows that only for the unversioned course_home. Removed from both mounts.

    All three are in #39310. Side effect of (1): the CourseCreator admin can't add rows, so users only show up there once they request access.

    Longer term, ADR 0038 lists Studio home among the screen names to replace with resource endpoints; that's a separate follow-up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions