List plants | Swagger Petstore

1 parameter

limitintegeroptional

The maximum number of plants to return.

2 status codes

200Returns an array of plant objects, each with a name and an optional tag.

namestringrequired

The name of the plant

tagstringoptional

Tag to specify the type

400Returned when an unexpected error occurs.

errorintegerrequired

messagestringrequired

Error handling

A 400 is returned for an unexpected request error. When supplied, limit must be an integer.

import { Client } from "swagger-petstore---openapi-3-0-sdk";

const client = new Client({
  baseUrl: "/api/v3",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.plants.list({ limit: 20 });

[
  {
    "name": "Example Name",
    "tag": "example_value"
  }
]

Request

Response

Errors