Get a pet by ID | Sample - Swagger Petstore OpenAPI 3

1 parameter

petIdintegerrequired

The integer identifier of the pet to retrieve.

4 status codes

200Returns the pet object, including its identifier, name, category, image URLs, tags, and store status.

idintegeroptional

namestringrequired

categoryobjectoptional

photoUrlsarray<string>required

tagsarray<object>optional

statusstringoptional

pet status in the store

Allowed:availablependingsold

400Returned when `petId` is invalid.

404Returned when no pet exists with the supplied `petId`.

defaultReturned when an unexpected error occurs.

Error handling

A 400 is returned when petId is not a valid integer identifier. A 404 is returned when no pet exists with the supplied petId.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { apiKey: process.env.API_KEY },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.pet.get({ petId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "https://example.com"
  ],
  "tags": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name"
    }
  ],
  "status": "available"
}

Request

Response

Errors