Workspace

$envless->workspace->get()

Read the workspace the key is bound to

php
/** @return CurrentWorkspaceResource */
public function get(int|float|null $timeout = null): array

Returns 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

php
use Envless\Envless;

$envless = new Envless();

$workspace = $envless->workspace->get();

echo $workspace['slug'], PHP_EOL;

Parameters

ParameterTypeRequiredDescription
$timeoutint|floatNoSeconds each attempt of this call may take, the response body included, before it throws Envless\Exception\NetworkException with isTimeout() true. 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_found code, so only the message tells it apart from any other 404.
  • Reach for $envless->workspaces->list() when you need plan, virtualEnvsEnabled or customDomain.

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.