Passbolt

Passbolt is an open source password manager for teams. The Passbolt API provides programmatic access to manage resources (passwords), folders, users, groups, sharing, comments, metadata, and authentication via GPGAuth or JWT.

Passbolt publishes 27 API contracts indexed on the APIs.io network, including Authentication (GPGAuth) API, Authentication (JWT) API, Avatars API, and 24 more. Tagged areas include Password Manager, Security, Secrets, and Identity.

The Passbolt catalog on APIs.io includes 1 Spectral governance ruleset.

Passbolt’s developer surface includes authentication, documentation, engineering blog, and 10 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

32.4/100 thin ▬ flat Agent 20/100 agent aware Front door AI 2/6 trace Heartbeat 100/100 alive saas Full breakdown ↓
scored 2026-11-13 · rubric v0.28.0 · Show this score on your site →

AccessFreemiumSelf serve⚡ Free to try

1 published contract

Password Manager Security Secrets Identity

What this lets a business do 1

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Cybersecurity Management

BC-620

Directory SyncGroupsMulti-Factor AuthenticationPermissionsResourcesSecrets

POST /mfa/verify/{mfaProviderName}.json GET /permissions/resource/{resourceId}.json POST /directorysync/synchronize.json POST /groups.json

Kin Score

Kin Score How this is scored →
scored 2026-11-13 · rubric v0.28.0

Composite quality — 32.4/100 · thin

Contract Quality 9.1 / 19

Developer Ergonomics 3.6 / 15

Access Clarity 3.8 / 15

Operational Transparency 2.1 / 10

Contract Governance 1.2 / 9

Discoverability 4.3 / 8

Regulatory Posture 3.2 / 15

Create-or-Update Ergonomics 0.0 / 10

Agent readiness — 20/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 0 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 0 / 8

Request/Response Examples 0 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 0 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/passbolt/"><img src="https://apis.io/badge/passbolt/card.svg" alt="Passbolt on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

MCP Server +12 pts — deployment.mode + probe verdict on the mcp/ manifest, not the pointer; an unprobed slug falls back to authorship Ask about this →
Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented) Ask about this →
Stable Error Semantics +8 pts — OpenAPI $refs a shared error schema across 4xx/5xx responses (verified), else common[].type includes ErrorCatalog / ErrorCodes / DeclineCodes Ask about this →
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0 Ask about this →
Request/Response Examples +7 pts — share of operations carrying request/response examples; else an Examples / Code Samples link Ask about this →
Registration Without a Human +6 pts — a `registration_endpoint` in the served RFC 8414 / OIDC discovery document Ask about this →

9 more unmet checks in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Developer Ergonomics scores 23.8 — up to +15.2 composite points Ask about this →
Access Clarity scores 25.5 — up to +14.9 composite points Ask about this →
Contract Quality scores 48.4 — up to +12.9 composite points Ask about this →

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Not sure how this applies to your stack? Ask about any one item. Kin Lane reads every question, looks at your profile and your situation, and replies with what a fix would take — scoped to that one area, priced up front, yours whether you ship it or not. Ask a question →

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/passbolt/apis.yml: open an issue on github.com/api-evangelist/passbolt to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
DigitalOcean Marketplace (partner 1-click apps and SaaS add-ons)	builds-on	58.1	-	-
Browser Extension Stores (company-published Firefox add-ons; Chrome Web Store unreadable)	builds-on	58.1	-	-
OpenSSF Best Practices Badge Holders	builds-on	58.1	-	-

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 1

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

OpenAPI

measured — observed by APIs.io (published)

APIs 27

Individual APIs this provider publishes, each with its own machine-readable definition.

Passbolt Authentication (GPGAuth) API

The legacy authentication method, using the GPGAuth protocol. Find more [here](https://www.passbolt.com/docs/development/authentication).

Passbolt Authentication (JWT) API

JWT-based authentication is the preferred way to interact with the Passbolt API. Find more [here](https://www.passbolt.com/docs/development)

Passbolt Avatars API

Query avatar images.

Passbolt Comments API

Manipulate comments for resources.

Passbolt Directory Sync API

Run directory synchronization.

Passbolt Favorites API

The favorite endpoints are used to add or remove a `Resource` from your favorites.

Passbolt Folders API

Organize your passwords and share them in bulk using folders.

Passbolt GPG keys API

In order to encrypt information, the server and the clients needs the user's public keys. These OpenPGP endpoints let you query the saved public key data.

Passbolt Groups API

Organize users in logical groups to make it easier to share resources with them.

Passbolt Metadata keys API

Manipulate metadata keys.

Passbolt Metadata private keys API

Manipulate private keys for metadata.

Passbolt Metadata rotate key API

Gather information about metadata keys that needs to be rotated

Passbolt Metadata session key API

Gather information on the saved encrypted session keys cache

Passbolt Metadata types settings API

Retrieve information about the resource types settings selected by the administrators

Passbolt Metadata upgrade API

Upgrading elements to the new v5 metadata format

Passbolt Move API

Move a folder or a resource across folders.

Passbolt Multi-Factor Authentication API

Complete and validate authentication for users with MFA enabled.

Passbolt Permissions API

Query permissions for resources.

Passbolt Resource types API

Resource-types are used for describing how and what data is stored for a resource and its associated secrets.

Passbolt Resources API

A resource holds the metadata for its secrets.

Passbolt Roles API

Different categories of users.

Passbolt Secrets API

Secrets associated to resources.

Passbolt Settings API

Retrieve the server settings

Passbolt Shares API

Share resources and folders to users with an exhaustive permission system.

Passbolt Tags API

Get tags and add tags to resources to categorize them.

Passbolt Users API

User are entities with the ability to interact with the application.

Passbolt Health Check API

Gather data about the passbolt instance's health.

Scroll for all 27

Open Collections 27

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Authentication (GPGAuth) API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Authentication (JWT) API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Avatars API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Comments API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Directory Sync API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Favorites API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Folders API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) GPG keys API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Groups API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Healthcheck API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Metadata keys API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Metadata private keys API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Metadata rotate key API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Metadata session key API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Metadata types settings API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Metadata upgrade API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Move API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Multi-Factor Authentication API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Permissions API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Resource types API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Resources API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Roles API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Secrets API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Settings API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Shares API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Tags API

OPEN COLLECTION

Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Users API

OPEN COLLECTION

Scroll for all 27

Passbolt API pricing

Not yet checked against Passbolt's own pricing page. Compiled by API Evangelist on 2026-05-04; confirm before you rely on a figure. A free plan or tier is listed.

Plan	Price
Free freemium	Free
Professional paid	Free
Enterprise enterprise	—

Plan details, limits and sources →

Rate limits

Free Tier Default: 10 requests per minute
Free Tier Monthly Quota: 1000 requests per month
Professional Tier Default: 100 requests per minute

Compiled by API Evangelist, not yet checked against Passbolt's documentation. All 5 limits →

Pricing Plans 1

Published pricing tiers and plan structures.

Passbolt Plans Pricing

3 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Passbolt Rate Limits

5 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Passbolt Finops

FINOPS

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs. Counts are the severity each rule declares, not results of running them.

Passbolt API Rules

53 rules · 43 error-severity 9 warn-severity 1 info-severity

SPECTRAL

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Passbolt Authentication

apiKey/http · 2 schemes

SECURITY

Passbolt Domain Security

TLSv1.3 · DNSSEC · DMARC

SECURITY

Passbolt Vulnerability Disclosure

security.txt · contact published

SECURITY

Agentic Access (API Evangelist recommendations) 1

Recommended x-agentic-access execution contracts for AI agents.

Passbolt Agentic Access

90 operations · 51 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

Build 1

SDKs, sample code, and the tooling you integrate with

SourceCode

SourceCode

Access & Security 3

Authentication, authorization, and security posture

VulnerabilityDisclosure

VulnerabilityDisclosure

DomainSecurity

DomainSecurity

Authentication

Authentication

Operate 1

Status, limits, changes, and where to get help

RateLimits

RateLimits

Commercial 2

Pricing, plans, and the legal terms of use

Plans

Plans

FinOps

FinOps

Company 3

The organization behind the API

LinkedIn

Website

Website

Blog

Blog

Other 1

Properties that don't map to a standard resource type

CapabilityMap

CapabilityMap

Source (apis.yml)

aid: passbolt
name: Passbolt
description: Passbolt is an open source password manager for teams. The Passbolt API provides programmatic access to manage
  resources (passwords), folders, users, groups, sharing, comments, metadata, and authentication via GPGAuth or JWT.
type: Index
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: false
  label: Hosted service · you call their endpoint
  confidence: medium
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  gated: none
  gated_source:
  - onboarding
  label: Freemium · Self-serve signup
  confidence: medium
  source:
  - plans
  - authentication
  - security
  generated: '2026-11-13'
  method: derived
position: Consuming
access: 3rd-Party
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/passbolt.png
tags:
- Password Manager
- Security
- Secrets
- Identity
created: '2025-02-21'
modified: '2026-05-19'
url: https://raw.githubusercontent.com/api-evangelist/passbolt/refs/heads/main/apis.yml
specificationVersion: '0.23'
apis:
- aid: passbolt:passbolt-authentication-gpgauth-api
  name: Passbolt Authentication (GPGAuth) API
  description: 'The legacy authentication method, using the GPGAuth protocol.


    Find more [here](https://www.passbolt.com/docs/development/authentication).'
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Authentication (GPGAuth)
  properties:
  - type: OpenAPI
    url: openapi/passbolt-authentication-gpgauth-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-authentication-jwt-api
  name: Passbolt Authentication (JWT) API
  description: JWT-based authentication is the preferred way to interact with the Passbolt API. Find more [here](https://www.passbolt.com/docs/development)
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Authentication (JWT)
  properties:
  - type: OpenAPI
    url: openapi/passbolt-authentication-jwt-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-avatars-api
  name: Passbolt Avatars API
  description: Query avatar images.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Avatars
  properties:
  - type: OpenAPI
    url: openapi/passbolt-avatars-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-comments-api
  name: Passbolt Comments API
  description: Manipulate comments for resources.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Comments
  properties:
  - type: OpenAPI
    url: openapi/passbolt-comments-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-directory-sync-api
  name: Passbolt Directory Sync API
  description: Run directory synchronization.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Directory Sync
  properties:
  - type: OpenAPI
    url: openapi/passbolt-directory-sync-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-favorites-api
  name: Passbolt Favorites API
  description: The favorite endpoints are used to add or remove a `Resource` from your favorites.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Favorites
  properties:
  - type: OpenAPI
    url: openapi/passbolt-favorites-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-folders-api
  name: Passbolt Folders API
  description: Organize your passwords and share them in bulk using folders.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Folders
  properties:
  - type: OpenAPI
    url: openapi/passbolt-folders-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-gpg-keys-api
  name: Passbolt GPG keys API
  description: In order to encrypt information, the server and the clients needs the user's public keys. These OpenPGP endpoints
    let you query the saved public key data.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - GPG Keys
  tags_raw:
  - GPG keys
  properties:
  - type: OpenAPI
    url: openapi/passbolt-gpg-keys-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-groups-api
  name: Passbolt Groups API
  description: Organize users in logical groups to make it easier to share resources with them.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Group
  tags_raw:
  - Groups
  properties:
  - type: OpenAPI
    url: openapi/passbolt-groups-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-metadata-keys-api
  name: Passbolt Metadata keys API
  description: Manipulate metadata keys.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Metadata keys
  properties:
  - type: OpenAPI
    url: openapi/passbolt-metadata-keys-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-metadata-private-keys-api
  name: Passbolt Metadata private keys API
  description: Manipulate private keys for metadata.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Metadata private keys
  properties:
  - type: OpenAPI
    url: openapi/passbolt-metadata-private-keys-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-metadata-rotate-key-api
  name: Passbolt Metadata rotate key API
  description: Gather information about metadata keys that needs to be rotated
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Metadata rotate key
  properties:
  - type: OpenAPI
    url: openapi/passbolt-metadata-rotate-key-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-metadata-session-key-api
  name: Passbolt Metadata session key API
  description: Gather information on the saved encrypted session keys cache
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Metadata session key
  properties:
  - type: OpenAPI
    url: openapi/passbolt-metadata-session-key-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-metadata-types-settings-api
  name: Passbolt Metadata types settings API
  description: Retrieve information about the resource types settings selected by the administrators
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Metadata types settings
  properties:
  - type: OpenAPI
    url: openapi/passbolt-metadata-types-settings-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-metadata-upgrade-api
  name: Passbolt Metadata upgrade API
  description: Upgrading elements to the new v5 metadata format
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Metadata upgrade
  properties:
  - type: OpenAPI
    url: openapi/passbolt-metadata-upgrade-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-move-api
  name: Passbolt Move API
  description: Move a folder or a resource across folders.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Move
  properties:
  - type: OpenAPI
    url: openapi/passbolt-move-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-multi-factor-authentication-api
  name: Passbolt Multi-Factor Authentication API
  description: Complete and validate authentication for users with MFA enabled.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Multi-Factor Authentication
  properties:
  - type: OpenAPI
    url: openapi/passbolt-multi-factor-authentication-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-permissions-api
  name: Passbolt Permissions API
  description: Query permissions for resources.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Permissions
  properties:
  - type: OpenAPI
    url: openapi/passbolt-permissions-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-resource-types-api
  name: Passbolt Resource types API
  description: Resource-types are used for describing how and what data is stored for a resource and its associated secrets.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Resource Types
  tags_raw:
  - Resource types
  properties:
  - type: OpenAPI
    url: openapi/passbolt-resource-types-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-resources-api
  name: Passbolt Resources API
  description: A resource holds the metadata for its secrets.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Resources
  properties:
  - type: OpenAPI
    url: openapi/passbolt-resources-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-roles-api
  name: Passbolt Roles API
  description: Different categories of users.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Roles
  properties:
  - type: OpenAPI
    url: openapi/passbolt-roles-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-secrets-api
  name: Passbolt Secrets API
  description: Secrets associated to resources.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Secrets
  properties:
  - type: OpenAPI
    url: openapi/passbolt-secrets-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-settings-api
  name: Passbolt Settings API
  description: Retrieve the server settings
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Settings
  properties:
  - type: OpenAPI
    url: openapi/passbolt-settings-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-shares-api
  name: Passbolt Shares API
  description: Share resources and folders to users with an exhaustive permission system.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Share
  tags_raw:
  - Shares
  properties:
  - type: OpenAPI
    url: openapi/passbolt-shares-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-tags-api
  name: Passbolt Tags API
  description: Get tags and add tags to resources to categorize them.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Tags
  properties:
  - type: OpenAPI
    url: openapi/passbolt-tags-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-users-api
  name: Passbolt Users API
  description: User are entities with the ability to interact with the application.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - User
  tags_raw:
  - Users
  properties:
  - type: OpenAPI
    url: openapi/passbolt-users-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
- aid: passbolt:passbolt-health-check-api
  name: Passbolt Health Check API
  description: Gather data about the passbolt instance's health.
  humanURL: https://www.passbolt.com/docs/api/
  baseURL: https://passbolt.local
  tags:
  - Health Check
  properties:
  - type: OpenAPI
    url: openapi/passbolt-health-check-api-openapi.yml
  - type: Documentation
    url: https://www.passbolt.com/docs/api/
  - type: Signup
    url: https://www.passbolt.com/pricing
  - type: TermsOfService
    url: https://www.passbolt.com/terms
  - type: License
    url: https://www.gnu.org/licenses/agpl-3.0.html
common:
- type: Plans
  url: plans/passbolt-plans-pricing.yml
- type: RateLimits
  url: rate-limits/passbolt-rate-limits.yml
- type: FinOps
  url: finops/passbolt-finops.yml
- type: CapabilityMap
  url: capabilities/passbolt-capability-edges.yml
  name: Passbolt Business Capability Map
- type: AgenticAccess
  url: agentic-access/passbolt-agentic-access.yml
- type: VulnerabilityDisclosure
  url: security/passbolt-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/passbolt-domain-security.yml
- type: Authentication
  url: authentication/passbolt-authentication.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/passbolt
- type: Website
  url: https://www.passbolt.com
- type: Documentation
  url: https://www.passbolt.com/docs/
- type: SourceCode
  url: https://github.com/passbolt
- url: https://www.passbolt.com/blog
  type: Blog
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com

Passbolt API — frequently asked questions

Does Passbolt have an API?

Yes. APIs.io lists 27 APIs from Passbolt, including Passbolt Authentication (GPGAuth) API, Passbolt Authentication (JWT) API and Passbolt Avatars API, and 24 more.

Is there an OpenAPI specification for the Passbolt API?

Yes. APIs.io indexes 27 OpenAPI specifications for Passbolt, each linked for download from this page.

How do I authenticate with the Passbolt API?

Passbolt uses bearer-token authentication (apiKey/http · 2 schemes). The details are profiled on APIs.io as Passbolt Authentication.

How much does the Passbolt API cost?

APIs.io lists 3 pricing plans for Passbolt, with each plan's price, limits and inclusions under Pricing on this page.

Is the Passbolt API ready for AI agents?

Passbolt has a Kin Score of 32.4 out of 100 (thin) and an Agent Readiness score of 19.6 (agent-aware), scored by API Evangelist on 2026-11-13.

Work with this as data

Every provider 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 providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
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 provider

curl "https://apis.io/api/v1/providers/passbolt"

All providers

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

Every operation they expose

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

How their score was established

curl "https://apis.io/api/v1/providers/passbolt/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.