Plandex Users API

User listing and removal within an org.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

plandex-users-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Plandex Server Accounts Users API
  description: Management and orchestration REST API exposed by the Plandex server (open-source, Go) used by the Plandex CLI/REPL to drive long-running coding plans across organizations, projects, plans, branches, context, conversation, model packs, and configuration. The same API powered Plandex Cloud (winding down 2025-10-03) and now powers self-hosted / local-mode deployments via Docker. Default local-mode bind is http://localhost:8099.
  version: '2'
  contact:
    name: Plandex AI
    url: https://plandex.ai
  license:
    name: MIT
    url: https://github.com/plandex-ai/plandex/blob/main/LICENSE
  termsOfService: https://plandex.ai/terms
servers:
- url: http://localhost:8099
  description: Default self-hosted / local-mode Plandex server (Docker)
- url: https://api.plandex.ai
  description: Plandex Cloud (winding down as of 2025-10-03; no longer accepting new users)
security:
- BearerAuth: []
tags:
- name: Users
  description: User listing and removal within an org.
paths:
  /orgs/users/{userId}:
    delete:
      tags:
      - Users
      summary: Delete Org User
      description: Remove a user from the org.
      operationId: deleteOrgUser
      parameters:
      - in: path
        name: userId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: User removed.
  /users:
    get:
      tags:
      - Users
      summary: List Users
      description: List users in the current org.
      operationId: listUsers
      responses:
        '200':
          description: List of users.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token issued by the Plandex server on sign-in. Used by the CLI/REPL for all authenticated API calls.