Bitwarden

Bitwarden Collections API

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

GitHub OpenAPI

Operations 4

GET /public/collections/{id} Retrieve a collection.
PUT /public/collections/{id} Update a collection.
DELETE /public/collections/{id} Delete a collection.
GET /public/collections List all collections.

Documentation

📖
Documentation
https://bitwarden.com/help/api/
📖
Documentation
https://bitwarden.com/help/api/#tag/Groups
📖
Documentation
https://bitwarden.com/help/api/#tag/Collections
📖
Documentation
https://bitwarden.com/help/api/#tag/Policies
📖
Documentation
https://bitwarden.com/help/event-logs/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bitwarden/refs/heads/main/openapi/bitwarden-collections-api-openapi.yml

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/bitwarden-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.

GitHub Google LinkedIn

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

OpenAPI Specification

bitwarden-collections-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Bitwarden Public Collections API
  description: The Bitwarden public APIs.
  contact:
    name: Bitwarden Support
    url: https://bitwarden.com
    email: support@bitwarden.com
  license:
    name: GNU Affero General Public License v3.0
    url: https://github.com/bitwarden/server/blob/master/LICENSE.txt
  version: latest
servers:
- url: https://api.bitwarden.com
security:
- OAuth2 Client Credentials:
  - api.organization
tags:
- name: Collections
paths:
  /public/collections/{id}:
    get:
      tags:
      - Collections
      summary: Retrieve a collection.
      description: 'Retrieves the details of an existing collection. You need only supply the unique collection identifier

        that was returned upon collection creation.'
      parameters:
      - name: id
        in: path
        description: The identifier of the collection to be retrieved.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CollectionResponseModel'
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseModel'
            text/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseModel'
        '404':
          description: Not Found
    put:
      tags:
      - Collections
      summary: Update a collection.
      description: 'Updates the specified collection object. If a property is not provided,

        the value of the existing property will be reset.'
      parameters:
      - name: id
        in: path
        description: The identifier of the collection to be updated.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: The request model.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/CollectionUpdateRequestModel'
          application/json:
            schema:
              $ref: '#/components/schemas/CollectionUpdateRequestModel'
          text/json:
            schema:
              $ref: '#/components/schemas/CollectionUpdateRequestModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CollectionUpdateRequestModel'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CollectionResponseModel'
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseModel'
            text/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseModel'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
        '404':
          description: Not Found
    delete:
      tags:
      - Collections
      summary: Delete a collection.
      description: Permanently deletes a collection. This cannot be undone.
      parameters:
      - name: id
        in: path
        description: The identifier of the collection to be deleted.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
        '404':
          description: Not Found
  /public/collections:
    get:
      tags:
      - Collections
      summary: List all collections.
      description: 'Returns a list of your organization''s collections.

        Collection objects listed in this call do not include information about their associated groups.'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CollectionResponseModelListResponseModel'
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseModelListResponseModel'
            text/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseModelListResponseModel'
components:
  schemas:
    AssociationWithPermissionsRequestModel:
      required:
      - id
      - readOnly
      type: object
      properties:
        id:
          type: string
          description: The associated object's unique identifier.
          format: uuid
          example: bfbc8338-e329-4dc0-b0c9-317c2ebf1a09
        readOnly:
          type: boolean
          description: When true, the read only permission will not allow the user or group to make changes to items.
      additionalProperties: false
    CollectionUpdateRequestModel:
      type: object
      properties:
        groups:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AssociationWithPermissionsRequestModel'
          description: The associated groups that this collection is assigned to.
        externalId:
          maxLength: 300
          minLength: 0
          type:
          - string
          - 'null'
          description: External identifier for reference or linking this collection to another system.
          example: external_id_123456
      additionalProperties: false
    CollectionResponseModelListResponseModel:
      required:
      - data
      - object
      type: object
      properties:
        object:
          type: string
          description: String representing the object's type. Objects of the same type share the same properties.
          readOnly: true
          example: list
        data:
          type: array
          items:
            $ref: '#/components/schemas/CollectionResponseModel'
          description: An array containing the actual response elements, paginated by any request parameters.
        continuationToken:
          type:
          - string
          - 'null'
          description: A cursor for use in pagination.
      additionalProperties: false
    AssociationWithPermissionsResponseModel:
      required:
      - id
      - readOnly
      type: object
      properties:
        id:
          type: string
          description: The associated object's unique identifier.
          format: uuid
          example: bfbc8338-e329-4dc0-b0c9-317c2ebf1a09
        readOnly:
          type: boolean
          description: When true, the read only permission will not allow the user or group to make changes to items.
      additionalProperties: false
    ErrorResponseModel:
      required:
      - message
      - object
      type: object
      properties:
        object:
          type: string
          description: String representing the object's type. Objects of the same type share the same properties.
          readOnly: true
          example: error
        message:
          type: string
          description: A human-readable message providing details about the error.
          example: The request model is invalid.
        errors:
          type:
          - object
          - 'null'
          additionalProperties:
            type: array
            items:
              type: string
          description: 'If multiple errors occurred, they are listed in dictionary. Errors related to a specific

            request parameter will include a dictionary key describing that parameter.'
      additionalProperties: false
    CollectionResponseModel:
      required:
      - id
      - object
      type: object
      properties:
        object:
          type: string
          description: String representing the object's type. Objects of the same type share the same properties.
          readOnly: true
          example: collection
        id:
          type: string
          description: The collection's unique identifier.
          format: uuid
          example: 539a36c5-e0d2-4cf9-979e-51ecf5cf6593
        groups:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AssociationWithPermissionsResponseModel'
          description: The associated groups that this collection is assigned to.
        externalId:
          maxLength: 300
          minLength: 0
          type:
          - string
          - 'null'
          description: External identifier for reference or linking this collection to another system.
          example: external_id_123456
      additionalProperties: false
      description: A collection.
  securitySchemes:
    OAuth2_Client_Credentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://identity.bitwarden.com/connect/token
          scopes:
            api.organization: Organization APIs