Finds Pets by status

client.pets.findByStatus(?, ?): 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

Accepts one of the following:

"available"

"pending"

"sold"

ReturnsExpand Collapse

PetFindByStatusResponse = Array<Pet { name, photoUrls, id, 3 more } >

name: string

photoUrls: Array<string>

id?: number

category?: Category { id, name }

id?: number

name?: string

status?: "available" | "pending" | "sold"

pet status in the store

Accepts one of the following:

"available"

"pending"

"sold"

tags?: Array<Tag>

id?: number

name?: string

Finds Pets by status

import ArenaDemoDayDemoDocsDemoSite from 'arena-demo-day-demo-docs-demo-site-and-typescript-library';

const client = new ArenaDemoDayDemoDocsDemoSite({
  apiKey: 'My API Key',
});

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"
      }
    ]
  }
]