API reference

Every public endpoint, with request and response schemas and a place to try it, is in the interactive reference served by the API.

Open the REST API reference

Conventions

• Base URL: https://api.rollout.so. All public routes start with /v1.

• Browser feed (/v1/feed, /v1/announcements/{id}/read): a publishable key in X-Rollout-Key plus the user’s identity. See Identity.

• Server API (/v1/subjects): a secret key as Authorization: Bearer sk_live_…. See Server API.

• Public changelog (/v1/changelogs/{slug}): no authentication. See Public changelog.

• Pagination: list endpoints take limit (1–50, default 20) and cursor, and return nextCursor, which is null on the last page.

• Errors share one shape, with a machine-readable error code:

  { "error": "invalid_token", "message": "Invalid or expired identity token" }

  Validation errors use validation_failed and add issues.

• Rate limits: 300 requests per minute per API key and client IP.