script

list runnables (scripts, flows, apps, agents) merged, ordered and keyset-paginated

Changed on
get/w/{workspace}/runnables/list

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/runnables/list
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Query parameters

order_by'updated' | 'name'

sort key: 'updated' (default) or 'name'

order_descboolean

order by desc order (default true)

kindsstring

comma-separated subset of script,flow,app,agent (default all)

show_archivedboolean
include_without_mainboolean

include library scripts (no runnable main)

path_startstring

restrict to paths under this prefix

labelstring
searchstring

case-insensitive fuzzy match on "summary (path)": the query is split into terms on runs of anything but ASCII letters, digits and apostrophes, and each of the first 8 must appear whole and in order, with anything in between. Terms past the 8th are ignored, so an over-long query matches more rows rather than fewer. Omitted or empty filters nothing; a query holding no ASCII-alphanumeric character at all (a lone space, "_", or text in a non-Latin script) yields no terms and matches nothing, mirroring the homepage, whose matcher discards those queries too.

per_pageinteger

number of items to return for a given page (default 30, max 100)

cursorstring

opaque keyset cursor from a previous page's next_cursor

include_draft_onlyboolean

also list the caller's drafts at paths with no deployed row, sorted and paginated with the deployed ones. Ignored for operators, in the archived view, and under a label filter (a draft carries no labels).

Response

a page of merged, ordered runnables

next_cursorstring

Changes

    • warning

      added the new agent enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status