findAnimals

GET

/animals

curl --request GET \
  --url 'https://example.com/api/animals?sort=asc&limit=10'

Returns all animals

Parameters

Query Parameters

tags

Array<string>

>= 1 items <= 10 items unique items

Tags to filter by

sort

string

Allowed values: asc desc

Sort order

limit

integer format: int32

default: 10 >= 1 < 100 multiple of 2

Maximum number of animals to return

filter

string

>= 3 characters <= 100 characters /^[a-zA-Z0-9]+$/

Specify a filter query

Responses

200

Animal response

Array<object>

object

name

required

string

tag

string

id

required

integer format: int64

Example

[
  {
    "id": 1,
    "name": "Bessy"
  },
  {
    "id": 2,
    "name": "Hazel"
  }
]

Array<object>

object

name

required

string

tag

string

id

required

integer format: int64

Example

[
  {
    "id": 3,
    "name": "Cleo"
  },
  {
    "id": 4,
    "name": "Daisy"
  }
]

Array<object>

object

name

required

string

tag

string

id

required

integer format: int64

Array<object>

object

name

required

string

tag

string

id

required

integer format: int64

default

Unexpected error

object

code

required

integer format: int32

message

required

string

Example^generated

{
  "code": 1,
  "message": "example"
}

object

code

required

integer format: int32

message

required

string

object

code

required

integer format: int32

message

required

string

object

code

required

integer format: int32

message

required

string