def list(limit: nil, offset: nil, timeout: nil)def list: (
?limit: Integer?,
?offset: Integer?,
?timeout: seconds?
) -> Page[workspace_resource]Returns one page of every workspace the API key owner is a member of. This is the only read in the SDK that leaves the workspace the key is bound to, because it resolves memberships for the owner instead of rows inside one workspace.
Seeing a workspace in items does not mean you can act on it. A key is bound to a single workspace at creation and cannot be retargeted, so the entry with current: true is the only one every other method will touch.
The server loads all memberships before it slices the page, so pagination[:totalCount] is the size of the complete set rather than of the page you received.
Example
require "envless/sdk"
page = Envless.workspaces.list(limit: 50)
current = page.items.find { |workspace| workspace[:current] }
puts "#{current&.fetch(:slug)} #{page.pagination[:totalCount]}"Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit: | Integer | No | Rows per page, a whole number from 1 to 100, defaulting to 25. |
offset: | Integer | No | Whole number of rows to skip before the page starts. |
timeout: | Integer | Float | Rational | No | Seconds each attempt of this call may take, redirects and the response body included, before it raises Envless::NetworkError with timeout? set. Overrides the client's timeout for this call, and 0 turns the limit off. |
Returns
Page[workspace_resource] with items and a pagination envelope covering every membership.
Reads the workspaces collection. list returns one page as an Envless::Page with items and pagination, list_all collects every page into an array, and iterate yields one item at a time to a block, fetching the next page only when it gets there. Without a block, iterate returns an Enumerator.
Worth knowing
- A 401 with
auth.api_key_user_missingmeans the key is valid but its owner row can no longer be read.
Required scopes
workspace:read
Underlying endpoint
GET /workspaces
Request and response schema, every error code, and a live playground.
In TypeScript
envless.workspaces.list()
The same method in @goenvless/sdk, with the same request, retries and errors.