Linkwarden Dashboard API

The Dashboard API from Linkwarden — 2 operation(s) for dashboard.

Operations 3

GET /api/v1/dashboard Get dashboard data (v1) #
GET /api/v2/dashboard Get dashboard data (v2) #
PUT /api/v2/dashboard Update dashboard layout (v2) #

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/linkwarden:linkwarden-dashboard-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.

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

OpenAPI Specification

linkwarden-dashboard-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: Linkwarden OpenAPI Documentation.
  version: 1.0.0
  title: Introduction Dashboard API
  license:
    name: GNU Affero General Public License v3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
tags:
- name: Dashboard
paths:
  /api/v1/dashboard:
    get:
      security:
      - bearerAuth: []
      summary: Get dashboard data (v1)
      description: Retrieves the dashboard data for the authenticated user.
      operationId: getDashboard
      tags:
      - Dashboard
      responses:
        '200':
          description: Dashboard data successfully retrieved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: array
                    description: List of resources with associated collections.
                    items:
                      $ref: '#/components/schemas/Link'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v2/dashboard:
    get:
      security:
      - bearerAuth: []
      summary: Get dashboard data (v2)
      description: Retrieves the dashboard data for the authenticated user.
      operationId: getDashboardV2
      tags:
      - Dashboard
      responses:
        '200':
          description: Dashboard data successfully retrieved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      links:
                        type: array
                        items:
                          $ref: '#/components/schemas/Link'
                      collectionLinks:
                        type: object
                        additionalProperties:
                          type: array
                          items:
                            $ref: '#/components/schemas/Link'
                      numberOfPinnedLinks:
                        type: integer
                        example: 0
                      numberOfTags:
                        type: integer
                        example: 0
                  message:
                    type: string
                    example: Dashboard data fetched successfully.
                  success:
                    type: boolean
                    example: true
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      security:
      - bearerAuth: []
      summary: Update dashboard layout (v2)
      description: Replaces the authenticated user's dashboard section layout.
      operationId: updateDashboardLayoutV2
      tags:
      - Dashboard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                required:
                - type
                - enabled
                properties:
                  type:
                    type: string
                    enum:
                    - STATS
                    - RECENT_LINKS
                    - PINNED_LINKS
                    - COLLECTION
                  collectionId:
                    type:
                    - integer
                    - 'null'
                  enabled:
                    type: boolean
                  order:
                    type: integer
      responses:
        '200':
          description: Dashboard layout updated successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      links:
                        type: array
                        items:
                          $ref: '#/components/schemas/Link'
                      collectionLinks:
                        type: object
                        additionalProperties:
                          type: array
                          items:
                            $ref: '#/components/schemas/Link'
                      numberOfPinnedLinks:
                        type: integer
                      numberOfTags:
                        type: integer
                  message:
                    type: string
                  success:
                    type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    Link:
      type: object
      properties:
        id:
          type: integer
          example: 4
        name:
          type: string
          example: Example link
        type:
          type: string
          example: url
        description:
          type: string
          example: Some additional thoughts...
        createdById:
          type: integer
          example: 1
        collectionId:
          type: integer
          example: 3
        icon:
          type:
          - string
          - 'null'
          example: Airplane
        iconWeight:
          type:
          - string
          - 'null'
          example: fill
          enum:
          - fill
          - bold
          - light
          - regular
          - duotone
          - thin
        color:
          example: '#0ea5e9'
          type: string
        url:
          type: string
          example: https://example.com
        textContent:
          type:
          - string
          - 'null'
          example: Example Domain  This domain is for use in illustrative examples in documents. You may use this  domain in literature without prior coordination or asking for permission.  More information...
        preview:
          type:
          - string
          - 'null'
          example: archives/preview/3/4.jpeg
        image:
          type:
          - string
          - 'null'
          example: archives/preview/3/4.jpeg
        pdf:
          type:
          - string
          - 'null'
          example: archives/preview/3/4.pdf
        readable:
          type:
          - string
          - 'null'
          example: archives/3/4_readability.json
        monolith:
          type:
          - string
          - 'null'
          example: unavailable
        lastPreserved:
          type:
          - string
          - 'null'
          format: date-time
          example: '2024-12-02T00:40:22.295Z'
        importDate:
          type:
          - string
          - 'null'
          example: '2024-12-02T00:40:22.295Z'
        createdAt:
          type: string
          example: '2024-12-02T00:40:22.295Z'
          format: date-time
        updatedAt:
          type: string
          example: '2024-12-02T00:40:22.295Z'
          format: date-time
        tags:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                example: 2
              name:
                type: string
                example: Technology
              ownerId:
                type: integer
                example: 1
              createdAt:
                type: string
                example: '2024-12-02T00:40:22.295Z'
                format: date-time
              updatedAt:
                type: string
                example: '2024-12-02T00:40:22.295Z'
                format: date-time
        collection:
          type: object
          properties:
            id:
              type: integer
              example: 3
            name:
              type: string
              example: Health and Wellness
            description:
              type: string
              example: Latest articles on health and wellness.
            icon:
              type:
              - string
              - 'null'
              description: Acorn
            iconWeight:
              type:
              - string
              - 'null'
              example: fill
              enum:
              - fill
              - bold
              - light
              - regular
              - duotone
              - thin
            color:
              example: '#0ea5e9'
              type: string
            parentId:
              type:
              - integer
              - 'null'
              example: null
            isPublic:
              type: boolean
              example: false
            ownerId:
              type: integer
              example: 1
            createdById:
              type: integer
              example: 2
            createdAt:
              type: string
              example: '2024-12-02T00:40:22.295Z'
              format: date-time
            updatedAt:
              type: string
              example: '2024-12-02T00:40:22.295Z'
              format: date-time
        pinnedBy:
          type: array
          items:
            type: integer
          example:
          - 1
          - 2
          - 3
    ErrorResponse:
      type: object
      properties:
        response:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT