Skip to content

List all flocks

GET
/api/v1/flocks

Returns a list of all flocks. Optionally filter by search term.

search
string

Filter flocks by name or bucket

List of flocks

object
data
Array<object>
object
id
string
name
string
status
string
breed
string

Unauthorized - missing or invalid credentials

object
error
object
code

Error code

string
Allowed values: BAD_REQUEST UNAUTHORIZED NOT_FOUND CONFLICT INTERNAL_ERROR
message

Human-readable error message

string