Skip to content

workspace_list

Asynchronously list the workspaces currently known by herdr.

List workspaces visible to the Herdr session.

Returns:

Type Description
WorkspaceListResult

A schema-derived workspace list result.

Example
client = AsyncHerdrClient()
result = await client.workspace_list()
for workspace in result["workspaces"]:
    print(workspace["workspace_id"])
Source code in src/herdr_client/async_client/client.py
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
async def workspace_list(self) -> WorkspaceListResult:
    """List workspaces visible to the Herdr session.

    Returns:
        A schema-derived workspace list result.

    Example:
        ```python
        client = AsyncHerdrClient()
        result = await client.workspace_list()
        for workspace in result["workspaces"]:
            print(workspace["workspace_id"])
        ```
    """
    return await self.request("workspace.list")