Skip to content
Starlight OpenAPI

List all animals

Deprecated
GET
/animals

Returns all animals

Find out more about our animals

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
deprecated
integer format: int32
nullable <= 50
Allowed values: 10 20 50

How many animals to return at one time (max 50)

tags
required
Array<string>
Allowed values: fish horse

Tags to filter by

Header Parameters

Section titled “Header Parameters ”
offset
integer format: int32

The number of animals to skip before starting to collect the result set

Responses

Section titled “ Responses ”

200

Section titled “200 ”

A paged array of animals

Array<object>
<= 100 items
object
id
required
integer format: int64
name
required
Name of the animal

A friendly name for the animal.

string
tag
string
Example
{
  "id": 1,
  "name": "dog",
  "tag": "pet"
}

default

Section titled “default ”

Unexpected error

object
code
required
integer format: int32
message
required
string