Sign in

v2

latestOpenAPI 3.1.02026-08-05313314398.1 KB
steps

List Steps

List steps, optionally filtered by project.

get/api/v1/steps/

Query parameters

project_idstring uuid nullable

Response

Successful Response

idstring uuid required
project_idstring uuid required
company_idstring uuid required
user_idstring uuid required
slugstring required
titlestring required
descriptionstring required
step_type'source' | 'data_read' | 'process' | 'data_sink' | 'database' | 'dashboard' required

The role a step plays in the project DAG.

code_type'python' | 'sql' required

Runtime language for the step code.

sink_target'database' required

Where a data_sink step writes its output.

provider_idstring uuid nullable required
parent_step_idsstring[] required
orderinteger required
code_urlstring required
in_formatstring required
out_formatstring required
referenced_database_idsstring[] required
input_schemaobject[] nullable required
operator_typestring nullable
operator_configobject nullable
extra_metadataobject nullable
entity_idstring uuid nullable
statusstring
is_suppressedboolean required
created_atstring date-time required
updated_atstring date-time required
database_namestring nullable