---
name: joplin-api
description: Manage Joplin notes via REST API. Use for creating, reading, updating, deleting, or searching Joplin notes programmatically.
allowed-tools: Bash(joplin-api:*)
homepage: https://joplinapp.org/help/api/references/rest_api/
metadata:
  openclaw:
    requires:
      bins: [python3]
    install:
      - id: deps
        kind: pip
        package: requests python-dotenv
        label: Install Python dependencies
    env:
      - name: JOPLIN_BASE_URL
        required: false
        default: http://localhost:41184
        description: Joplin Data API base URL
      - name: JOPLIN_TOKEN
        required: true
        description: API Token from Joplin Web Clipper settings
      - name: JOPLIN_IMPORT_DIR
        required: false
        default: /root/.openclaw/workspace
        description: Allowed directory for import operations
      - name: JOPLIN_EXPORT_DIR
        required: false
        default: /root/.openclaw/workspace
        description: Allowed directory for export operations
  minis:
    originalSource: "https://clawskills.sh/skills/killgfat-joplin-api"
    convertedAt: "2026-10-31T22:11:59.518Z"
    license: "Unknown"
---

# Joplin API Skill

Manage Joplin notes, notebooks, and tags via Joplin Data API.

---

## Environment Variables

| Variable | Required | Default | Description |
|----------|----------|---------|-------------|
| `JOPLIN_BASE_URL` | No | `http://localhost:41184` | Joplin API URL |
| `JOPLIN_TOKEN` | **Yes** | - | API Token from Web Clipper |

---

## Quick Start

### 1. Get API Token

1. Open Joplin → **Tools** → **Options** → **Web Clipper**
2. Enable service and copy the token

### 2. Test Connection

```bash
python3 joplin.py ping
```

---

## Basic Commands

```bash
python3 joplin.py ping                    # Test connection
python3 joplin.py create --title "Title"  # Create note
python3 joplin.py search "keyword"        # Search
python3 joplin.py list --type notes       # List notes
python3 joplin.py stats                   # Statistics
```

---

## Security

- Import/Export restricted to workspace directory
- Sensitive system directories blocked

---

## Documentation

- `references/API.md` - Full API reference
- `references/CONFIGURATION.md` - Configuration examples