list_children

List a folder's immediate child folders (navigation tree, paged).

list_children

List a folder's immediate child folders (navigation tree, paged).

Return all immediate children of a folder, paging until exhausted.

Safety class: A · API type: admin · Min version:

📘

Confinement

Read-only; safe anywhere.

Signatures

def list_children(sdk, folder_id, page_size=500):
    """All immediate children of folder_id as a list of dicts."""
    items, page = [], 0
    while True:
        result = sdk.get_asset_child_nodes(folder_id, folder_id, "name", False, page, page_size)
        batch = result.get("items", []) if isinstance(result, dict) else (result or [])
        items.extend(batch)
        if len(batch) < page_size:
            break
        page += 1
    return items
export async function listChildren(sdk, folderId, pageSize = 500) {
    // All immediate children of folderId, paged until exhausted.
    const items = [];
    let page = 0;
    for (;;) {
        const result = await sdk.getAssetChildNodes(folderId, folderId, "name", false, page, pageSize);
        const batch = Array.isArray(result) ? result : (result?.items ?? []);
        items.push(...batch);
        if (batch.length < pageSize) break;
        page += 1;
    }
    return items;
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
folder_idfolderIdstryese.g. <folder-uuid>
page_sizepageSizeintnoitems per page

Returns

list[dict] — child FOLDERS (navigation tree); each has id, name (NOT displayName), parentId, assetType (1 == folder), hasChildren. Uploaded files are NOT returned here -- list files via search (parentId Equals). See recipes/folder-navigation.md.

Errors

  • 401 unauthenticated
  • 404 folder not found

See also: Python ↔ JS naming map · Return shapes.