Skip to content

List all animals

Deprecated
GET
/animals
curl --request GET \
--url 'https://example.com/api/animals?limit=10&tags=fish' \
--header 'Authorization: Bearer <token>'

Returns all animals

Find out more about our animals

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

offset
integer format: int32

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

A paged array of animals

Media typeapplication/json
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"
}
]

Unexpected error

Media typeapplication/json
object
code
required
integer format: int32
message
required
string
Examplegenerated
{
"code": 1,
"message": "example"
}