Skip to content
rp-test-docs-1
Get started
API Reference
Pets

Finds Pets by status

client.pets.findByStatus(PetFindByStatusParams { status } query?, RequestOptionsoptions?): PetFindByStatusResponse { name, photoUrls, id, 3 more }
GET/pet/findByStatus

Multiple status values can be provided with comma separated strings

ParametersExpand Collapse
query: PetFindByStatusParams { status }
status?: "available" | "pending" | "sold"

Status values that need to be considered for filter

One of the following:
"available"
"pending"
"sold"
ReturnsExpand Collapse
PetFindByStatusResponse = Array<Pet { name, photoUrls, id, 3 more } >
name: string
photoUrls: Array<string>
id?: number
formatint64
category?: Category { id, name }
id?: number
formatint64
name?: string
status?: "available" | "pending" | "sold"

pet status in the store

One of the following:
"available"
"pending"
"sold"
tags?: Array<Tag { id, name } >
id?: number
formatint64
name?: string

Finds Pets by status

import RpTestDocs1 from 'rp-test-docs-1';

const client = new RpTestDocs1({
  apiKey: process.env['PETSTORE_API_KEY'], // This is the default and can be omitted
});

const pets = await client.pets.findByStatus();

console.log(pets);
[
  {
    "name": "doggie",
    "photoUrls": [
      "string"
    ],
    "id": 10,
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "status": "available",
    "tags": [
      {
        "id": 0,
        "name": "name"
      }
    ]
  }
]
Returns Examples
[
  {
    "name": "doggie",
    "photoUrls": [
      "string"
    ],
    "id": 10,
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "status": "available",
    "tags": [
      {
        "id": 0,
        "name": "name"
      }
    ]
  }
]