def get(
*,
timeout: float | None = None,
) -> CurrentWorkspaceResourceasync def get(
*,
timeout: float | None = None,
) -> CurrentWorkspaceResourceReturns the workspace the API key belongs to. The binding lives on the key, not on the request, so there is no argument that would point this method at a different workspace.
The returned CurrentWorkspaceResource is narrower than the workspace shape you get elsewhere: it carries id, name, slug, icon and createdAt only. plan, virtualEnvsEnabled and customDomain are absent here, and envless.workspaces.list is the method that returns them. envless.workspace.update returns a third shape, one that includes virtualEnvsEnabled but drops createdAt.
Example
from envless import envless
workspace = envless.workspace.get()
print(workspace['slug'])import asyncio
from envless import AsyncEnvless
async def main() -> None:
async with AsyncEnvless() as envless:
workspace = await envless.workspace.get()
print(workspace['slug'])
asyncio.run(main())Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
timeout | float | No | Seconds each attempt of this call may take, the response body included, before it raises EnvlessNetworkError with is_timeout set. Overrides the client's timeout for this call, and 0 turns the limit off. |
Returns
CurrentWorkspaceResource with id, name, slug, icon and createdAt.
Worth knowing
- A 404 here means the workspace was soft-deleted while the key survived. It carries the generic
request.not_foundcode, so only the message tells it apart from any other 404. - Reach for
envless.workspaces.listwhen you needplan,virtualEnvsEnabledorcustomDomain.
Required scopes
workspace:read
Underlying endpoint
GET /workspace
Request and response schema, every error code, and a live playground.
In TypeScript
envless.workspace.get()
The same method in @goenvless/sdk, with the same request, retries and errors.