---
id: workflow-folder-list
title: List folders
description: >-
  Lists one level of the workflows tree: the subfolders of `parent`, sorted by
  name, paginated. Folders come from the `path` of your workflows, so a folder
  exists while at least one workflow is in it or below it.
sidebar_label: List folders
hide_title: true
hide_table_of_contents: true
api: >-
  eJztWE2P2zYQ/SsDXpqiWltJE7TQbRs0RYoiCNoEWyBZVLQ4sthQpJYc2esa+u/FUJItrx27bQq0h5x2LQ5n3nw9krMVJJdBZO/EjfMfSuPWoLDUVpN2NojbRCgMhdcN/xaZ+EkHCuAsgsEVGnAlUIWwHjYHII+YxW+hXZTOKPSBpfJGerSUJxCcJ1Sw2ICVNSbQyKW2klDN4MUgX7gaofSujoryRlKVs5KNa/3eFqsCCb0RwPsIbV1pgyAJDMpAEem4AXQAbUETOA8LjF9o9t6+t1dwo6mC/C5PokWjA7F0aSSBtoFQqgxwhX4zmpME0m5AYUPVoGx0EdaVCxi9g1pSUWGYes3ezNjmtQVtV9JoxYA8NshRgEZ6WSMhf6LW2wBP03QmEuEa9JLz8FKJTIxeXfWAMsYsErHbzUndCs1Ju2vRb0QiGJHIRA9TJCIUFdZSZFtBm4ZXAnltl4KTXsrWkMjEXHQPa+BNhWMUek8nmZa+jx5nM5/nHEQOqHeO2AW8l3Vj2NRcFqzuShPWQXTJaah3Z1Ae4XouA15pG9AGTXqFEFD6ogK3Qj8CZr0hOZe9Q5jK65I+Cs/oWp8MpLaES/TTSD5O00TU8l7XbS2yJ2l6Mq6DANi2XqDnmh8j26DnVkF4VBhZN6iAHDxJ0y8PAD9mvafBurIMeAFtrW2PL50gP400kPSk7RIapy1B6fzYydrZA0xpd5uIgEXrNW1iVS5QevTXLVUie3fLyx5D42zAwLCepCn/Oba5o4q+Q/fRYXuFs8R1nW2FbBqji4hk/nvg7dtjr93idyxiy3juLNK9cSVpKiW9lxzEvk75u6ZYGSNf9pwlkiO1h/Cvxwo8yZh76uMGso4gkPOowFmW1h7c2kZa3XyUHA+0zo78YrnTrT6F+cr5Whr9B6oRL+/LQDKfKk53Ps8TsA7IS22GD2daey5rfTV20VCKl0Bwqg2zd8BljZaG84OqB4YOVCvtOe6ne3Cq/WYX+Z693NqOUYxsxbwfXT8w9nWXCHIkzd+yoO1UIdM8044rQVOY0GYCeQ8/B20L0ypUB8afdYmoZHheaaM82gmEhXMGpT2GUCFV6GNRDMYrGQ7PxZ39mei67ox/XTIw3cmlgVdOrHW92qe//nrczs+N5syi987PgDO+cGoDQW44L5Jgzctr7+wyA2l7QcjZRJ6AhKqtpb3yKJVcGIRcIUlteMmqhNsmHqyRAqCU2rSeeZ/dRkt+E+nUlSXaWNSlRqPOkEjj3cJg/dUJMhno4HUvcZEHBuq0Sno1OBUdf/Tzi+fwzbfpNzDYgt4jvjqgX6ECGSD/GKb8y+OG73Fc6rXvIwSWgbc/v0wAZ8sZ5BVRE7L5fHfJCJtAWM8UruYRdNgvWUdXpWutetCd/0gHF9QQ0mPke92vHJ84g3wgSW042Ze7HU/Tp/EU45BeUr2/MK75VqgVrMvfdHnz3eKmbNplaoe7Jtvmy6G0xQW4O0fDfHK7nj9Qy/r6wJw4fw6z9tpjiMR4ss6zy3W+P87OHoYfOzQmrgXCJsxDIe28cLbU8WJWYwhyeSEqdRsIKrlC8HjXaj7uBusb+KJwCr8YKCSyyLNTLPLW4n2DBd8IYpf4gVA+d/LnTv7cyf/LTo46qXL8hl1i/2RlaNPQDtcifqvEru7fsq03k2KUjZ7Z1pjGSCqdr2eFq8X0pfELd3bv/PS9sfODFY2voXiVikIiGf55wTdhfgH/ePNGdLFASsfbGU+fu8ezdJaKXZmLVxM4cP36JcevcYFqGalmeIfxCAX2Hh6Uw3ZPW59HLf/hqGUoEcJ7mjdG6tjRsf7GTnq3G8BwEsd03iaicoF4ebtdyIBvvek6/tw/xrmMlQ58ZVUiK6UJeKYCPmHQctKBD7iZjn9W0rQsFMcbfx3VvzdmOQPy7p/j+4QxyhlA46jnE0BdnJicMb8b3uzt3/IPrxlAnKIkokLJowgusn7XdVFgM911NBhhLTs6/uH7NyIR8pAmH9Bi1D6eaHYz0b3d9hJv3Ae0XSdG6MS/RXfbdd2fpP7UUA==
sidebar_class_name: get api-method
info_path: docs/api/nullplatform-api
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/workflow-folder-list'
---
<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List folders"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/workflows/folders"}
  context={"endpoint"}
>

</MethodEndpoint>

Lists one level of the workflows tree: the subfolders of `parent`, sorted by name, paginated. Folders come from the `path` of your workflows, so a folder exists while at least one workflow is in it or below it.

- With `q`, the list is flat instead: every folder at any depth below `parent` whose name matches, sorted by path.
- An invalid or repeated parameter returns 400.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"query","name":"parent","schema":{"type":"string","default":"/"},"description":"The folder whose subfolders are listed. `/` is the root.","example":"/action-items"},{"in":"query","name":"q","schema":{"type":"string"},"description":"Case-insensitive search over folder names, at any depth below `parent`.","example":"drift"},{"in":"query","name":"limit","schema":{"type":"integer","default":100,"maximum":200},"description":"The maximum number of folders per page (clamped to 200).","example":100},{"in":"query","name":"offset","schema":{"type":"integer","minimum":0,"default":0},"description":"The starting point for pagination.","example":0}]}
>

</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>

</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The paginated list of folders.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"title":"WorkflowFolder","type":"object","description":"A folder of the workflows tree. Folders are not stored on their own: they come from the `path` of the workflows.","properties":{"path":{"type":"string","description":"Normalized folder path: a leading `/`, no trailing `/`.","example":"/action-items/ami-drift"},"name":{"type":"string","description":"The last segment of `path`.","example":"ami-drift"},"direct":{"type":"integer","description":"Workflows whose own `path` is this folder.","example":3},"total":{"type":"integer","description":"Workflows in this folder or any of its subfolders, `direct` included.","example":5},"hasChildren":{"type":"boolean","description":"Whether the folder has at least one subfolder."}}}},"total":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"}}}}}},"4XX":{"description":"Client error. The body says what went wrong: an error `type`, a human-readable `detail`, and, on validation failures, one entry per offending field.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}},"5XX":{"description":"Unexpected server error.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}}}}
>

</StatusCodes>

