List workspaces

GET/v1/workspaces

List workspaces.

Returns every workspace in the organization, not paginated.

Requires a member of the organization (any role), or an organization-scoped va_ key with the admin or member role. A workspace-scoped key is refused with 403; it can read its own workspace with GET /v1/workspaces/{slug}.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Query parameters

organizationstringrequired
the organization's slug

Responses

200application/json

workspacesobject[]
The workspaces; the list is not paginated.
Child attributes
- idstring<uuid>
  The workspace's id (UUID), used as workspace_id elsewhere in the API.
- organizationstring
  The slug of the organization the workspace belongs to.
- slugstring
  The workspace's slug, unique within the organization, used in workspace URLs.
- namestring
  The workspace's display name.
- descriptionstring
  A description of the workspace; absent when none was given.
- default_routing_config_slugstring
  The routing config the dashboard selects by default for this workspace; absent when none is set.
- created_atstring<date-time>
  When the workspace was created (ISO 8601 date-time).
- updated_atstring<date-time>
  When the workspace was last changed (ISO 8601 date-time).
totalinteger<int32>
The number of entries in workspaces.

VectorAxis is built by GK Labs, a member of NVIDIA Inception.