Field Filtering

Field filtering lets clients reduce response payloads by naming the fields they want back.

Example

GET /v1/sites?fields=id,name,status,production_url

The response should include only the requested fields:

{
  "data": [
    {
      "id": "site_123",
      "name": "Acme Developer Docs",
      "status": "active",
      "production_url": "https://docs.acme.test"
    }
  ]
}

Rules

• field names should match response property names
• omitted required identifiers can still be included when needed for pagination or links
• secret fields cannot be requested through filtering
• invalid field names should produce a clear validation error

Why it matters

Docs workflows can fan out across many sites, releases, domains, and references. Field filtering keeps dashboards, SDKs, and AI readers from moving more data than they need.