SparkyFitness

SparkyFitness Dashboard Layouts API

The Dashboard Layouts API from SparkyFitness — 1 operation(s) for dashboard layouts.

Documentation GitHub OpenAPI

Operations 3

GET /dashboard-layouts/{pageKey} Get the saved widget layout for a dashboard page #

PUT /dashboard-layouts/{pageKey} Create or update the widget layout for a dashboard page #

DELETE /dashboard-layouts/{pageKey} Reset a dashboard page layout to defaults (deletes the stored row) #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/sparkyfitness-dashboard-layouts-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: SparkyFitness Dashboard Layouts API
  version: 1.0.0
  description: API documentation for the SparkyFitness application, providing a comprehensive guide to all available endpoints.
  contact:
    name: SparkyFitness Support
servers:
- url: https://{host}/api
  description: Self-hosted SparkyFitness instance (the operator supplies the host). The upstream spec declares the relative base "/api".
  variables:
    host:
      default: sparkyfitness.example.com
      description: Hostname of your own SparkyFitness deployment. SparkyFitness is self-hosted; there is no vendor-operated API host.
security:
- apiKeyAuth: []
tags:
- name: Dashboard Layouts
paths:
  /dashboard-layouts/{pageKey}:
    get:
      summary: Get the saved widget layout for a dashboard page
      tags:
      - Dashboard Layouts
      security:
      - apiKeyAuth: []
      parameters:
      - in: path
        name: pageKey
        required: true
        schema:
          type: string
        description: The dashboard page identifier (e.g. "diary").
      responses:
        '200':
          description: The saved layout, or null when none is stored (use defaults).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardLayout'
        '400':
          description: Unknown page key.
        '401':
          description: Unauthorized.
      operationId: getDashboardLayoutsByPageKey
      x-operation-id-source: derived
    put:
      summary: Create or update the widget layout for a dashboard page
      tags:
      - Dashboard Layouts
      security:
      - apiKeyAuth: []
      parameters:
      - in: path
        name: pageKey
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - layout
              - hidden
              properties:
                layout:
                  type: object
                hidden:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: The saved layout.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardLayout'
        '400':
          description: Invalid payload or unknown page key.
        '401':
          description: Unauthorized.
      operationId: putDashboardLayoutsByPageKey
      x-operation-id-source: derived
    delete:
      summary: Reset a dashboard page layout to defaults (deletes the stored row)
      tags:
      - Dashboard Layouts
      security:
      - apiKeyAuth: []
      parameters:
      - in: path
        name: pageKey
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Layout reset; the client should fall back to defaults.
        '400':
          description: Unknown page key.
        '401':
          description: Unauthorized.
      operationId: deleteDashboardLayoutsByPageKey
      x-operation-id-source: derived
components:
  schemas:
    DashboardLayout:
      type: object
      properties:
        layout:
          type: object
          description: Responsive grid layout keyed by breakpoint (lg/md/sm/xs).
        hidden:
          type: array
          items:
            type: string
          description: Widget keys the user has hidden.
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key authentication via x-api-key header.
x-provenance:
  generated: '2026-08-27'
  method: derived
  source: https://github.com/CodeWithCJ/SparkyFitness — assembled from the project's own swagger-jsdoc configuration (SparkyFitnessServer/config/swagger.ts) and the 419 @swagger JSDoc blocks in SparkyFitnessServer/routes/**, using the same scan paths and the same cookieAuth->apiKeyAuth post-processing the server applies. This is the identical document a running instance serves at GET /api/api-docs/json (Swagger UI at /api/api-docs/swagger, ReDoc at /api/api-docs/redoc).
  note: 'Not fetched from a live host: SparkyFitness is self-hosted and the project operates no public instance, so the contract can only be read from the source that generates it. Upstream sets no operationIds; paths+methods are the stable identifiers.'
  upstream_version: server package.json 1.6.4 (release v1.6.4, 2026-08-27)