Sign in
Dashboard V2

Changed on

Get the saved dashboard layout for an owner. owner_type/owner_id default to the authenticated user's personal dashboard. Returns null config when no layout has been saved yet.

get/dashboard/layout

Request

  • Base URL: /api/v2 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/dashboard/layout
  • Auth: loggedin (a scheme the document does not define)

Query parameters

owner_type'user' | 'org' | 'shop'

Wire types for the customizable dashboard. These are the single source of truth for the DashboardConfig shape: TSOA emits them into the OpenAPI spec, and the frontend client codegen turns them into matching TypeScript types — so the same structure is used for server persistence, the API contract, and the client with no casting.

owner_idstring

Response

Ok

owner_type'user' | 'org' | 'shop' required

Wire types for the customizable dashboard. These are the single source of truth for the DashboardConfig shape: TSOA emits them into the OpenAPI spec, and the frontend client codegen turns them into matching TypeScript types — so the same structure is used for server persistence, the API contract, and the client with no casting.

owner_idstring required
updated_bystring required
updated_atstring required

Changes

  • 347aad6a1d88Revision changes
    • ▲

      the /// response's property type changed from object to no type for status

    • ▲

      removed the required property //// from the response with the status

    • ▲

      removed the required property //// from the response with the status

    • ▲

      removed the required property //// from the response with the status

    • ▲

      removed the required property //// from the response with the status

    • ▲

      removed the required property //// from the response with the status

  • 0f3027b1b7ceRevision changes
    • ○

      endpoint added