Skip to main content
GET
List sequences

Authorizations

X-API-Key
string
header
required

Query Parameters

search
string | null
Maximum string length: 255
include_holds
boolean
default:true

Read what holds each running sequence. False leaves every hold empty and answers much faster: for a caller that needs only the sequences themselves, such as a picker.

Response

Successful Response

The list rows plus when their rollup metrics were last computed.

sequences
SequenceReadSchema · object[]
required
stats_refreshed_at
string<date-time> | null
required

When the list's stats were computed. Stats of any age are served at once. None only when they have never been built and could not be built on this request (for example, another request was building them).

stats_refreshing
boolean
required

True when the stats were more than five minutes old and a refresh is running in the background. Read the list again a few seconds later for newer numbers and a newer stats_refreshed_at.