Response Format

Most endpoints return one of two JSON envelopes: a list response or an item response.

List response

{
  "data": [],
  "meta": {
    "total": 0,
    "limit": 100,
    "offset": 0,
    "count": 0
  }
}

data contains records. meta contains pagination and endpoint-specific metadata.

Item response

{
  "data": {
    "id": 1,
    "name": "Mazowieckie"
  }
}

Detail endpoints usually return a single object in data.

Error response

{
  "error": "Not found"
}

Rate limiting can include extra fields:

{
  "error": "rate_limited",
  "message": "Too many requests",
  "retryAfterSeconds": 60
}