V2 Features

Core features available in version 2

📌 You’re viewing documentation for V2. Consider upgrading to the Latest version for new features.

V2 Overview

Version 2 of the Plantman API provides a solid foundation for managing your plant inventory and operations.

Core Features

Plant CRUD Operations

Manage your plants with simple, intuitive endpoints:

1import { PlantmanClient } from "@plantman/sdk";
2
3const client = new PlantmanClient({
4 apiKey: "your-api-key"
5});
6
7// Create a plant
8const plant = await client.plants.create({
9 name: "Monstera",
10 species: "Monstera deliciosa",
11 waterFrequency: "weekly"
12});
13
14// Get a plant
15const retrieved = await client.plants.get(plant.id);
16
17// Update a plant
18const updated = await client.plants.update(plant.id, {
19 waterFrequency: "biweekly"
20});
21
22// Delete a plant
23await client.plants.delete(plant.id);

Find plants in your collection:

List Plants
1// List all plants
2const allPlants = await client.plants.list();
3
4// Paginated results
5const page1 = await client.plants.list({ page: 1, pageSize: 10 });
6const page2 = await client.plants.list({ page: 2, pageSize: 10 });
7
8// Search by name
9const results = await client.plants.search({ query: "monstera" });

Authentication

V2 uses API key authentication:

1

Get Your API Key

Log into your dashboard and navigate to Settings → API Keys

2

Include in Requests

Add the Authorization header to all requests:

$curl https://api.plantman.com/v2/plants \
> -H "Authorization: Bearer YOUR_API_KEY"

Rate Limits

V2 has the following rate limits:

PlanRequests per MinuteRequests per Day
Free601,000
Pro60050,000
EnterpriseCustomCustom

When you exceed rate limits, you’ll receive a 429 Too Many Requests response.

Error Handling

V2 uses standard HTTP status codes:

  • 200 OK: Request succeeded
  • 201 Created: Resource created successfully
  • 204 No Content: Resource deleted successfully

Data Models

Plant Object

1{
2 "id": "plt_abc123",
3 "name": "Monstera",
4 "species": "Monstera deliciosa",
5 "waterFrequency": "weekly",
6 "lightRequirement": "indirect",
7 "height": 24,
8 "createdAt": "2025-01-15T10:30:00Z",
9 "updatedAt": "2025-01-15T10:30:00Z"
10}

Supported Languages

V2 SDKs are available in:

  • TypeScript/JavaScript
  • Python
  • Go
  • Java

Upgrading to Latest

Ready for more features? Check out what’s new in the Latest version!

The Latest version includes bulk operations, webhooks, enhanced filtering, and more!