Linkwarden Public API

The Public API from Linkwarden — 5 operation(s) for public.

Operations 5

GET /api/v1/public/collections/tags Get tags for a collection #
GET /api/v1/public/users/{id} Get user by ID #
GET /api/v1/public/links/{id} Get a link by ID #
GET /api/v1/public/collections/{id} Get a collection by its ID #

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-public-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-public-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: Linkwarden OpenAPI Documentation.
  version: 1.0.0
  title: Introduction Public API
  license:
    name: GNU Affero General Public License v3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
tags:
- name: Public
paths:
  /api/v1/public/collections/links:
    get:
      summary: Retrieve links from a specific collection
      tags:
      - Public
      parameters:
      - name: collectionId
        in: query
        required: true
        schema:
          type: integer
          example: 4
      - name: sort
        in: query
        required: false
        schema:
          type: integer
          example: 1
      - name: cursor
        in: query
        required: false
        schema:
          type: integer
          example: 10
      - name: pinnedOnly
        in: query
        required: false
        schema:
          type: boolean
          example: true
      - name: searchQueryString
        in: query
        required: false
        schema:
          type: string
          example: example search query
      - name: searchByName
        in: query
        required: false
        schema:
          type: boolean
          example: true
      - name: searchByUrl
        in: query
        required: false
        schema:
          type: boolean
          example: true
      - name: searchByDescription
        in: query
        required: false
        schema:
          type: boolean
          example: true
      - name: searchByTextContent
        in: query
        required: false
        schema:
          type: boolean
          example: true
      - name: searchByTags
        in: query
        required: false
        schema:
          type: boolean
          example: true
      responses:
        '200':
          description: Successfully retrieved the list of links.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: array
                    items:
                      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
        '400':
          $ref: '#/components/responses/BadRequest'
      operationId: getApiV1PublicCollectionsLinks
      x-operation-id-source: derived
  /api/v1/public/collections/tags:
    get:
      summary: Get tags for a collection
      tags:
      - Public
      parameters:
      - name: collectionId
        in: query
        description: The ID of the collection to retrieve tags for
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: A list of tags for the collection
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 2
                        name:
                          type: string
                          example: Technology
                        ownerId:
                          type: integer
                          example: 1
                        createdAt:
                          type: string
                          format: date-time
                          example: '2024-12-02T00:40:22.295Z'
                        updatedAt:
                          type: string
                          format: date-time
                          example: '2024-12-02T00:40:22.295Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          description: Collection not found or no tags available
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: string
                    example: Collection not found
      operationId: getApiV1PublicCollectionsTags
      x-operation-id-source: derived
  /api/v1/public/users/{id}:
    get:
      summary: Get user by ID
      tags:
      - Public
      parameters:
      - name: id
        in: path
        description: The ID of the user to retrieve
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: A user object
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      name:
                        type: string
                        example: John Doe
                      username:
                        type: string
                        example: user1
                      email:
                        type:
                        - string
                        - 'null'
                      image:
                        type: string
                      archiveAsScreenshot:
                        type: boolean
                        example: false
                      archiveAsMonolith:
                        type: boolean
                        example: false
                      archiveAsPDF:
                        type: boolean
                        example: true
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: getApiV1PublicUsersById
      x-operation-id-source: derived
  /api/v1/public/links/{id}:
    get:
      summary: Get a link by ID
      tags:
      - Public
      parameters:
      - name: id
        in: path
        description: The ID of the link to retrieve
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successfully retrieved the link.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: object
                    $ref: '#/components/schemas/Link'
      operationId: getApiV1PublicLinksById
      x-operation-id-source: derived
  /api/v1/public/collections/{id}:
    get:
      summary: Get a collection by its ID
      tags:
      - Public
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: The ID of the collection
      responses:
        '200':
          description: Successfully retrieved the collection.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    $ref: '#/components/schemas/Collection'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: getApiV1PublicCollectionsById
      x-operation-id-source: derived
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        response:
          type: string
    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
        _count:
          type: object
          properties:
            links:
              type: integer
              example: 3
        members:
          type: array
          items:
            type: object
            properties:
              userId:
                type: integer
                example: 3
              collectionId:
                type: integer
                example: 4
              canCreate:
                type: boolean
                example: true
              canUpdate:
                type: boolean
                example: true
              canDelete:
                type: boolean
                example: true
              createdAt:
                type: string
                format: date-time
                example: '2024-12-02T05:50:22.680Z'
              updatedAt:
                type: string
                format: date-time
                example: '2024-12-02T05:50:22.680Z'
              user:
                type: object
                properties:
                  username:
                    type: string
                    example: user1
                  name:
                    type: string
                    example: John Doe
                  image:
                    type:
                    - string
                    - 'null'
                    example: null
    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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT