PetstoreAPI Docs
Modern Petstore APIClassic Petstore APIBlog
Modern Petstore APIClassic Petstore APIBlog
    • Modern Pet Store API: A New Gold Standard for OpenAPI
    • Pet
      • Get Pet
        GET
      • Update Pet
        PUT
      • Delete Pet
        DELETE
      • Create Pet
        POST
      • List Pets
        GET
      • Upload Pet Image
        POST
    • Chat
      • Create Chat Completion
        POST
    • Payments
      • Pay Order
        POST
    • Store
      • List Inventory
        GET
      • Create Order
        POST
      • Get Order
        GET
      • Delete Order
        DELETE
      • Callback Example
        POST
    • User
      • Create User
      • Update User
      • Get User
      • Delete User
      • Login
      • Logout
    • Webhooks
      • Pet Adopted Event
      • New Pet Available Event
    • Schemas
      • Pet
      • PetCollection
      • User
      • OrderPayment
      • Bank Card
      • Bank Account
      • Category
      • Links
      • Order
      • ApiResponse
      • Tag
      • Error
    Modern Petstore APIClassic Petstore APIBlog
    Modern Petstore APIClassic Petstore APIBlog

    PetCollection

    Collection of pets with pagination and hypermedia links

    {
        "data": [
            {
                "id": "pet_c4t_5x7k9m",
                "species": "DOG",
                "name": "Whiskers",
                "breed": "Domestic Shorthair",
                "ageMonths": 18,
                "size": "SMALL",
                "color": "Orange Tabby",
                "gender": "MALE",
                "goodWithKids": true,
                "goodWithPets": true,
                "adoptionFee": 75,
                "description": "string",
                "status": "AVAILABLE",
                "intakeDate": "2019-08-24",
                "photos": [
                    "http://example.com"
                ],
                "medicalInfo": {
                    "spayedNeutered": true,
                    "vaccinated": true,
                    "microchipped": true,
                    "specialNeeds": true,
                    "notes": "string"
                },
                "links": {
                    "self": "http://example.com",
                    "adopt": "http://example.com"
                }
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 1,
            "totalItems": 0,
            "totalPages": 0
        },
        "links": {
            "self": "http://example.com",
            "first": "http://example.com",
            "prev": "http://example.com",
            "next": "http://example.com",
            "last": "http://example.com"
        }
    }
    Built with