API Reference

Pets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List

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

GET/pets

ReturnsExpand Collapse

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

Accepts one of the following:

"available"

"pending"

"sold"

tags?: Array<Tag { id, name } >

id?: number

name?: string

List

TypeScript

HTTP

TypeScript

Python

Go

Ruby

import Barkend from 'barkend';

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

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

console.log(pets);

200 example

[
  {
    "name": "name",
    "photoUrls": [
      "string"
    ],
    "id": 0,
    "category": {
      "id": 0,
      "name": "name"
    },
    "status": "available",
    "tags": [
      {
        "id": 0,
        "name": "name"
      }
    ]
  }
]

Returns Examples

200 example

[
  {
    "name": "name",
    "photoUrls": [
      "string"
    ],
    "id": 0,
    "category": {
      "id": 0,
      "name": "name"
    },
    "status": "available",
    "tags": [
      {
        "id": 0,
        "name": "name"
      }
    ]
  }
]