canonical: https://jentic.com/apis/teampass.net/teampass

# Teampass API

Teampass is a collaborative passwords manager. The API enables CRUD operations on passwords/items, folders, and users with API key authentication. The API exposes 16 endpoints secured with apiKey authentication.

## For AI agents

Programmatically authenticate and get API key, list all items accessible to user. Covers 16 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for identity and authentication only.

## Capabilities

- Authenticate and get API key
- List all items accessible to user
- Get item by ID
- Create a new item
- Update an item
- Delete an item

## Use cases

### Identity and Authentication Operations

Use the Teampass API to perform identity auth operations programmatically. The API provides 16 endpoints covering core functionality including authenticate and get API key, list all items accessible to user, get item by id.

Example prompt: Call POST `/api/index.php/auth` to authenticate and get API key

### Automated Items Management

Automate items operations by combining multiple Teampass API endpoints. Agents can list all items accessible to user and then get item by id in a single workflow.

Example prompt: Call GET `/api/index.php/items` to list all items accessible to user, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Teampass API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'authenticate and get API key', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/index.php/auth` | Authenticate and get API key |
| GET | `/api/index.php/items` | List all items accessible to user |
| GET | `/api/index.php/items/{itemId}` | Get item by ID |
| POST | `/api/index.php/item` | Create a new item |
| PUT | `/api/index.php/item/{itemId}` | Update an item |
| DELETE | `/api/index.php/item/{itemId}` | Delete an item |
| GET | `/api/index.php/items/folder/{folderId}` | List items in a folder |
| GET | `/api/index.php/folders` | List all folders |

## Key resources

- **Items** — Password/item management
- **Folders** — Folder management
- **Users** — User management
- **Authentication** — Auth operations

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 63 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 61 / 100
- **View full report:** https://jentic.com/apis/teampass.net/teampass/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Teampass API by hand means calling its auth endpoint for an API key, pointing every request at your own self-hosted host, and writing the folder and item paging and retry glue yourself. Through Jentic you install once, import the Teampass API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** The Teampass API puts the item id in the URL path (`/api/index.php/item/{itemId}`), so a rule can pin your agent to one item: it can read and update that item and nothing else. You choose the operations it may call, so destructive ones like deleting an item are not included unless you add them.
- **Credential handling:** Your Teampass API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'read a stored item' or 'list folders', and Jentic returns the matching Teampass API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Auth0** — Alternative identity auth API
- **Okta** — Alternative identity auth API

## FAQ

### What authentication does the Teampass API use?

The Teampass API uses an API key passed in the `APIKEY` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I authenticate and get API key with the Teampass API?

Yes. Use the POST `/api/index.php/auth` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Teampass API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I authenticate and get API key through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'authenticate and get API key'. Jentic returns the matching Teampass API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Teampass API have?

The Teampass API exposes 16 endpoints covering items, folders, users operations.

### Can I limit what my agent is allowed to do with the Teampass API?

Yes. Because you run Jentic One yourself, your own rules decide which Teampass API operations and credentials the agent may use. Since the item id sits in the URL path (`/api/index.php/item/{itemId}`), a rule can pin the agent to a single item so it only reads and updates that one item and nothing else. You choose the operations it may call, so a destructive operation like deleting an item stays off limits unless you explicitly add it.