API reference
Endpoint-by-endpoint reference for the Notifly REST API, generated from the OpenAPI document — one page per operation, grouped by resource.
Every endpoint of the Notifly REST API, generated from the OpenAPI document the API itself publishes. Each operation page carries the full request and response schemas, example payloads, and an interactive request builder.
Pick a resource from the sidebar to browse its operations — or start with the REST API guide for authentication, environments, pagination, idempotency, and rate limits, which apply to every endpoint here.
Generated, not hand-written
These pages come from a committed snapshot of https://api.notifly.io/openapi.json,
refreshed with npm run sync:openapi so builds stay hermetic. The live document
is always authoritative if the two ever disagree.
REST API
The versioned Notifly REST API at api.notifly.io — quickstart, API-key authentication, environments, errors, pagination, idempotency, rate limits, and subscriber credentials.
List all contexts GET
Retrieve a paginated list of all contexts, optionally filtered by type and key pattern. **type** and **id** are optional fields, if provided, only contexts with the matching type and id will be returned. **search** is an optional field, if provided, only contexts with the matching key pattern will be returned. Checkout all possible parameters in the query section below for more details