01
Introduction
Getting started with the Plantyic API

The Plantyic API is organized around REST. All requests should be made to the base URL using application/json content type.

Format
JSON only
Auth Method
Bearer Token
API Version
v1.0.0
HTTPS
Required

User Roles

Super Admin Admin Staff Vendor Customer
02
Authentication
How to authenticate your requests

Plantyic uses Bearer token authentication. After logging in, include the token in the Authorization header for all protected routes.

HTTP Header 
                        Authorization: Bearer YOUR_TOKEN_HERE
                        Content-Type: application/json
                        Accept: application/json
03
List Workspaces
GET /api/workspace

Returns a list of all workspaces the authenticated user has access to.

Sample Response
{
    "success": true,
    "message": "Workspace list fetched successfully",
    "error_code": null,
    "data": [
        {
            "id": 5,
            "name": "Demo Workspace",
            "description": "Workspace for testing",
            "icon": "icon.png",
            "color": "blue",
            "plan": "pro",
            "created_at": "2026-02-20T11:13:37.000000Z",
            "updated_at": "2026-02-20T11:13:37.000000Z"
        }
    ]
}
04
Create Workspace
POST /api/workspace

Initialize a new workspace. The creator is automatically assigned the Super Admin role for this workspace.

Body Parameters

Field Type Description
name string Required. The display name of the workspace.
description string Optional. A brief summary of the workspace purpose.
color string Optional. The color theme for the workspace (e.g., "blue", "green").
05
Get Workspace Details
GET /api/workspace/{id}

Fetch metadata, member counts, and recent activity for a specific workspace.

06
Update Workspace
PUT /api/workspace/{id}

Modify settings, names, or branding for an existing workspace.

07
Delete Workspace
DELETE /api/workspace/{id}

Warning: This action is permanent and will remove all associated projects and data.