Docs
Sign in

List live previews.

A private preview's url carries the host's access token and is given to the dashboard session only: for an API key it is null, and origin is the address without the token.

GET/api/v1/previews

Scoperead

A public preview has no token, so its url is given to both. No path parameters.

Query parameters.

crewIdstring

Only those of this crew. At least 5 characters.

taskIdstring

Only those of this task. At least 5 characters.

statearray

One or more states, comma-separated. Any of pending_approval, starting, up, stopping, stopped, failed. At least 1 item.

limit1–200

How many items to return, 1 to 200. Default 50.

cursorstring

The nextCursor of the previous page. Only valid with the same filters and order. At least 1 character.

orderenum

desc is newest first; asc is oldest first. Collections sort by creation time, then id. One of asc, desc. Default desc.

Response.

One page of a list: data holds the items (each a Preview); nextCursor and hasMore lead to the next page. The example has placeholder values.