Sign in

v106

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-03812347972.4 KB
script

list all scripts

get/w/{workspace}/scripts/list

Path parameters

workspacestring required

Query parameters

pageinteger

which page to return (start at 1, default 1)

per_pageinteger

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

order_descboolean

order by desc order (default true)

created_bystring

filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')

path_startstring

mask to filter matching starting path

path_exactstring

mask to filter exact matching path

first_parent_hashstring

mask to filter scripts whom first direct parent has exact hash

last_parent_hashstring

mask to filter scripts whom last parent in the chain has exact hash. Beware that each script stores only a limited number of parents. Hence the last parent hash for a script is not necessarily its top-most parent. To find the top-most parent you will have to jump from last to last hash until finding the parent

parent_hashstring

is the hash present in the array of stored parent hashes for this script. The same warning applies than for last_parent_hash. A script only store a limited number of direct parent

show_archivedboolean

(default false) show only the archived files. when multiple archived hash share the same path, only the ones with the latest create_at are ed.

include_without_mainboolean

(default false) include scripts without an exported main function

include_draft_onlyboolean

(default false) include scripts that have no deployed version

is_templateboolean

(default regardless) if true show only the templates if false show only the non templates if not defined, show all regardless of if the script is a template

kindsstring

(default regardless) script kinds to filter, split by comma

starred_onlyboolean

(default false) show only the starred items

with_deployment_msgboolean

(default false) include deployment message

languagesstring

Filter to only include scripts written in the given languages. Accepts multiple values as a comma-separated list.

without_descriptionboolean

(default false) If true, the description field will be omitted from the response.

dedicated_workerboolean

(default regardless) If true, show only scripts with dedicated_worker enabled. If false, show only scripts with dedicated_worker disabled.

labelstring

Filter by label

Response

All scripts

workspace_idstring
hashstring required
pathstring required
parent_hashesstring[]

The first element is the direct parent of the script, the second is the parent of the first, etc

summarystring required
descriptionstring required
contentstring required
created_bystring required
created_atstring date-time required
archivedboolean required
schemaobject
deletedboolean required
is_templateboolean required
extra_permsobject required
lockstring
lock_error_logsstring
language'python3' | 'deno' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'oracledb' | 'graphql' | 'nativets' | 'bun' | 'php' | 'rust' | 'ansible' | 'csharp' | 'nu' | 'java' | 'ruby' | 'rlang' | 'duckdb' | 'bunnative' | 'dbt' required
kind'script' | 'failure' | 'trigger' | 'command' | 'approval' | 'preprocessor' required
starredboolean required
tagstring
draft_onlyboolean
envsstring[]
concurrent_limitinteger
concurrency_time_window_sinteger
concurrency_keystring
debounce_keystring
debounce_delay_sinteger
debounce_args_to_accumulatestring[]
max_total_debouncing_timeinteger
max_total_debounces_amountinteger
cache_ttlnumber
dedicated_workerboolean
ws_error_handler_mutedboolean
priorityinteger
restart_unless_cancelledboolean
timeoutinteger
delete_after_secsinteger

If set, delete the job's args, result and logs after this many seconds following job completion

visible_to_runner_onlyboolean
auto_kindstring
codebasestring
has_preprocessorboolean required
on_behalf_of_emailstring
on_behalf_ofstring

Authorization identity the runnable runs as: u/{username}, g/{group}, or a bare email when the username is itself email-shaped. The only stored half of the identity; on_behalf_of_email is derived from it.

modulesobject nullable

Additional script modules keyed by relative file path

labelsstring[]
inherited_labelsstring[]

Labels inherited from the parent folder, computed at read time. Read-only — edit them on the folder.

is_draftboolean

True when the authed user has a draft for this script — either no deployed row exists at this path (draft-only) or the user saved a per-user draft on top of the deployed row.

draft_pathstring

User-typed path the editor has staged but not yet deployed. Surfaced for draft-only rows so the home list can render the meaningful name instead of the autogenerated u/{user}/draft_{uuid} URL path. Omitted when unchanged.