Skip to main content
GET
/
pet
/
findByStatus
JavaScript
import BeaverdockAPI from 'beaverdock-api';

const client = new BeaverdockAPI({
  apiKey: process.env['BEAVERDOCK_API_API_KEY'], // This is the default and can be omitted
});

const pets = await client.pet.findByStatus();

console.log(pets);
[
  {
    "name": "doggie",
    "photoUrls": [
      "<string>"
    ],
    "id": 10,
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "tags": [
      {
        "id": 123,
        "name": "<string>"
      }
    ],
    "status": "available"
  }
]

Authorizations

api_key
string
header
required

Query Parameters

status
enum<string>
default:available

Status values that need to be considered for filter

Available options:
available,
pending,
sold

Response

successful operation

name
string
required
Example:

"doggie"

photoUrls
string[]
required
id
integer<int64>
Example:

10

category
object
tags
object[]
status
enum<string>

pet status in the store

Available options:
available,
pending,
sold