pane_list

Asynchronously list panes, optionally restricted to one workspace.

List panes, optionally limited to one workspace.

Parameters:

Name	Type	Description	Default
workspace_id	str | None	Workspace identifier to filter by, or None for all workspaces.	None

Returns:

Type	Description
PaneListResult	A schema-derived pane list result.

Example

client = AsyncHerdrClient()
result = await client.pane_list(workspace_id="main")
print(result["panes"])

Source code in src/herdr_client/async_client/client.py

async def pane_list(self, workspace_id: str | None = None) -> PaneListResult:
    """List panes, optionally limited to one workspace.

    Args:
        workspace_id: Workspace identifier to filter by, or ``None`` for all
            workspaces.

    Returns:
        A schema-derived pane list result.

    Example:
        ```python
        client = AsyncHerdrClient()
        result = await client.pane_list(workspace_id="main")
        print(result["panes"])
        ```
    """
    params: PaneListParams = {}
    if workspace_id is not None:
        params["workspace_id"] = workspace_id
    return await self.request("pane.list", params)