List all pets.

client.pets.list(?): PetListResponse { name, photoUrls, id, 3 more }

get/pet

List all pets.

ReturnsExpand Collapse

PetListResponse = 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

Accepts one of the following:

"available"

"pending"

"sold"

tags?: Array<Tag>

id?: number

formatint64

name?: string

List all pets.

import Barkend from 'barkend';

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

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

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