DOCS / API REFERENCE

List coops

GET /v1/coops

GETHenHouse API v1

Request

GET /v1/coops

Authenticate with a bearer token. Create one with POST /v1/tokens or cluck login.

Parameters

NameTypeDescription
limitintegerMaximum results (default 20)
cursorstringPagination cursor from a previous response

Example

curl -X GET https://api.pollosoft.example/v1/coops?limit=10&cursor=example \
  -H "Authorization: Bearer $COOP_TOKEN"

Response

A successful call returns 200 OK with JSON like this:

{
  "data": [
    {
      "id": "coop_8f2a",
      "name": "main",
      "region": "us-east-1",
      "hens": 12,
      "status": "healthy"
    }
  ],
  "has_more": false
}

Errors

IdempotencyThis endpoint is safe to retry. Reads do not lay eggs.