API REFERENCE · PUBLIC

The Twist HTTP API

OpenAPI-generated reference for the REST API — documenting both installation-scoped and org-scoped keys, with a required scope on every endpoint. The whole reference is public and static — every endpoint is documented here, with none held back.

~92 endpoints

HTTP REST

One page per endpoint, with parameters, examples, and a required-scope badge. Fully public — no gated endpoints.

GET/devicesPOST/scenesBrowse the API →

how-to

Auth & scopes

Installation-scoped vs org-scoped keys, the scope model, and how the required-scope badge maps to each endpoint.

Installation-scoped keysOrg-scoped keysRead auth & scopes →

reference

Conventions

The shared rules every endpoint follows — pagination, errors, idempotency, and rate limits.

Errors & status codesPagination & rate limitsRead the conventions →

Looking for device, model & value types?Those live in the proprietary Device Model Reference — partners-only, gated by org type.Request partner access →