Linkwarden Collections API

The Collections API from Linkwarden — 2 operation(s) for collections.

Operations 5

GET /api/v1/collections Get all collections #
GET /api/v1/collections/{id} Get a collection by ID #
POST /api/v1/collections/{id} Create a new collection #
PUT /api/v1/collections/{id} Update an existing collection by ID #
DELETE /api/v1/collections/{id} Delete a collection by 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-collections-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-collections-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: Linkwarden OpenAPI Documentation.
  version: 1.0.0
  title: Introduction Collections API
  license:
    name: GNU Affero General Public License v3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
tags:
- name: Collections
paths:
  /api/v1/collections:
    get:
      security:
      - bearerAuth: []
      summary: Get all collections
      operationId: getAllCollections
      tags:
      - Collections
      responses:
        '200':
          description: List of collections successfully retrieved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: array
                    items:
                      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:
                          type: string
                          example: '#0ea5e9'
                        parentId:
                          type:
                          - integer
                          - 'null'
                          example: null
                        isPublic:
                          type: boolean
                          example: false
                        ownerId:
                          type: integer
                          example: 1
                        createdById:
                          type: integer
                          example: 2
                        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'
                        _count:
                          type: object
                          properties:
                            links:
                              type: integer
                              example: 3
                        parent:
                          type:
                          - object
                          - 'null'
                          properties:
                            id:
                              type: integer
                              example: 6
                            name:
                              type: string
                              example: New Collection
                        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
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/collections/{id}:
    get:
      security:
      - bearerAuth: []
      summary: Get a collection by ID
      operationId: getCollectionById
      tags:
      - Collections
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the collection to retrieve.
        schema:
          type: integer
      responses:
        '200':
          description: Collection successfully retrieved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    $ref: '#/components/schemas/Collection'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      security:
      - bearerAuth: []
      summary: Create a new collection
      operationId: createCollection
      tags:
      - Collections
      requestBody:
        description: The details of the collection to create.
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the collection.
                description:
                  type: string
                  description: The description of the collection.
                color:
                  type: string
                  description: The color of the collection.
                icon:
                  type: string
                  description: The icon of the collection.
                iconWeight:
                  type: string
                  description: The weight of the collection's icon.
                parentId:
                  type: integer
                  description: The ID of the parent collection, if applicable.
      responses:
        '200':
          description: Collection successfully created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    $ref: '#/components/schemas/Collection'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      security:
      - bearerAuth: []
      summary: Update an existing collection by ID
      operationId: updateCollection
      tags:
      - Collections
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the collection to update.
        schema:
          type: integer
      requestBody:
        description: The updated collection data.
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
                color:
                  type: string
                icon:
                  type: string
                iconWeight:
                  type: string
                parentId:
                  type: integer
                isPublic:
                  type: boolean
                members:
                  type: array
                  items:
                    type: object
                    properties:
                      userId:
                        type: integer
                      canCreate:
                        type: boolean
                      canUpdate:
                        type: boolean
                      canDelete:
                        type: boolean
      responses:
        '200':
          description: Collection successfully updated.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    $ref: '#/components/schemas/Collection'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    delete:
      security:
      - bearerAuth: []
      summary: Delete a collection by ID
      operationId: deleteCollectionById
      tags:
      - Collections
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the collection to delete.
        schema:
          type: integer
      responses:
        '200':
          description: Collection successfully deleted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: object
                    description: The deleted collection details.
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      description:
                        type: string
                      icon:
                        type:
                        - string
                        - 'null'
                      iconWeight:
                        type:
                        - string
                        - 'null'
                      color:
                        type: string
                      parentId:
                        type:
                        - integer
                        - 'null'
                      isPublic:
                        type: boolean
                      ownerId:
                        type: integer
                      createdById:
                        type: integer
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  responses:
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized
      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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT