API Reference

Pets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List all pets.

GET/pets

List all pets.

ReturnsExpand Collapse

name: string

photoUrls: array of string

id: optional number

formatint64

category: optional Category { id, name }

id: optional number

formatint64

name: optional string

status: optional "available" or "pending" or "sold"

pet status in the store

Accepts one of the following:

"available"

"pending"

"sold"

tags: optional array of Tag { id, name }

id: optional number

formatint64

name: optional string

List all pets.

HTTP

HTTP

TypeScript

Go

curl http://localhost:4000/api/v3/pets \
    -H "Authorization: Bearer $BARKEND_BEARER_TOKEN"

200 example

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

Returns Examples

200 example

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