List Workspaces

List workspaces visible to the public API principal.

GET /v1/public/accounts/{account_id}/workspaces

List Workspaces

cURL

curl --request GET \
  --url https://api.hybridbox.io/v1/public/accounts/{account_id}/workspaces \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "status": "active",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "page": 123,
  "page_size": 123,
  "total": 123
}

Authorizations

Authorization · string · header · required

Public API bearer credential sent as Authorization: Bearer <token>. Use either an OAuth access token or a Hybridbox Service account token.

Path Parameters

account_id · string<uuid> · required

Query Parameters

page · integer · default: 1

page_size · integer · default: 25

Response

200

application/json

items · WorkspaceResponse · object[] · required

Workspaces on this page

Hide child attributes

items. account_id · string<uuid> · required

Account UUID that owns the workspace

items. id · string<uuid> · required

Workspace UUID

items. name · string · required

Workspace display name

items. created_at · string<date-time> | null

Workspace creation timestamp

items. status · string · default: active

Workspace lifecycle status

items. updated_at · string<date-time> | null

Workspace last update timestamp

page · integer · required

Current one-based page number

page_size · integer · required

Maximum items per page

total · integer · required

Total matching workspaces