API Reference

Pets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Find pet by ID

client.pets.retrieve(numberpetID, RequestOptionsoptions?): Pet { name, photoUrls, id, 3 more }

GET/pet/{petId}

Returns a single pet

ParametersExpand Collapse

petID: number

formatint64

ReturnsExpand Collapse

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

Find pet by ID

TypeScript

HTTP

TypeScript

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 pet = await client.pets.retrieve(0);

console.log(pet.id);

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