Get a pet by ID | Swagger Petstore

1 parameter

petIdintegerrequired

The unique integer identifier of the pet to retrieve.

4 status codes

200Returns the pet object with its identifier, name, category, photo 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 not a valid pet identifier.

404Returned when no pet exists with the supplied petId.

defaultUnexpected error

Error handling

The petId value must be a valid integer identifier. An invalid identifier returns a 400, while an identifier for a pet that does not exist returns a 404.

import { SwaggerPetstoreOpenAPI30 } from "swagger-petstore---openapi-3-0-sdk";

const client = new SwaggerPetstoreOpenAPI30({
  baseUrl: "/api/v3",
  auth: { apiKey: process.env.SWAGGER_PETSTORE_API_KEY! },
});

const result = await client.pet.getById({ petId: 7082 });

{
  "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