API reference

Base URL https://www.policyeagle.org/api/v1. The machine-readable contract is at /api/v1/openapi.json (OpenAPI 3.1; no key needed).

Authentication

Send your key in the Authorization header on every request. Keys in query strings are not accepted.

Authorization: Bearer $POLICY_EAGLE_API_KEY

To rotate a key, choose Create replacement in your account: the old key keeps working for 24 hours. Revoking a key stops it immediately. If a key leaks, revoke it; when you contact us, send the request_id, never the key.

Responses and pagination

Successful responses are { "data": …, "meta": { "request_id": … } }. Lists return meta.next_cursor; pass it back as cursor with the same filters to get the next page. It is null on the last page. A cursor used with different filters is rejected. Bill ids are permanent within their session, but the order of results can change when the data refreshes.

Errors

{ "error": { "code": "INVALID_REQUEST", "message": "Some parameters are invalid.",
             "details": [{ "field": "sort", "message": "…" }] },
  "meta": { "request_id": "req_…" } }

Rate limits

Every response carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset (seconds) for your tightest window, plus X-Request-Id. Limits are shared by all your keys; GET /me shows both windows.

Endpoints