List workspaces

client.Admin.Workspaces.List(ctx, query) (*CursorPage[AdminWorkspaceListResponse], error)

GET/compute/v1/admin/workspaces

List workspaces

ParametersExpand Collapse

query AdminWorkspaceListParams

AfterID param.Field[string]optional

Return results after this ID

BeforeID param.Field[string]optional

Return results before this ID

Limit param.Field[int64]optional

Max items to return

minimum1

maximum100

ReturnsExpand Collapse

type AdminWorkspaceListResponse struct{…}

ID string

Workspace ID

ArchivedAt Time

formatdate-time

CreatedAt Time

formatdate-time

DataRetention AdminWorkspaceListResponseDataRetention

How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours).

Unit AdminWorkspaceListResponseDataRetentionUnit

Time unit for retention duration

Accepts one of the following:

const AdminWorkspaceListResponseDataRetentionUnitHours AdminWorkspaceListResponseDataRetentionUnit = "hours"

const AdminWorkspaceListResponseDataRetentionUnitDays AdminWorkspaceListResponseDataRetentionUnit = "days"

Value int64

Duration value. Maximum retention is 14 days (or 336 hours).

minimum1

IsDefault bool

Whether this is the default workspace

Name string

Workspace name

UpdatedAt Time

formatdate-time

List workspaces

package main

import (
  "context"
  "fmt"

  "github.com/boltz-bio/boltz-api-go"
  "github.com/boltz-bio/boltz-api-go/option"
)

func main() {
  client := boltzapi.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Admin.Workspaces.List(context.TODO(), boltzapi.AdminWorkspaceListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "data": [
    {
      "id": "id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "created_at": "2019-12-27T18:11:19.117Z",
      "data_retention": {
        "unit": "hours",
        "value": 1
      },
      "is_default": true,
      "name": "name",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

Returns Examples

{
  "data": [
    {
      "id": "id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "created_at": "2019-12-27T18:11:19.117Z",
      "data_retention": {
        "unit": "hours",
        "value": 1
      },
      "is_default": true,
      "name": "name",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}