> For the complete documentation index, see [llms.txt](https://docs.nebulablock.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces.md).

# Object Storage

List your Nebula Block object storage workspaces, with status, charges, and pagination.

List the object storage workspaces on your account. A workspace is the container that holds your buckets and carries its own S3 access key pair.

## HTTP Request

`GET` `{API_URL}/object-storage/`

where `API_URL = https://api.nebulablock.com/api/v1`.

## Query Parameters

| Parameter      | Requirement | Type      | Description                                                                                                                                                         |
| -------------- | ----------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `space_status` | Required    | `string`  | Which workspaces to return. `Ready` returns active workspaces; **any other value** (the console sends `_Ready`) returns workspaces that are `Deleted` or `Disabled` |
| `page`         | Optional    | `integer` | Page number, starting at `1`. Defaults to `1`                                                                                                                       |
| `limit`        | Optional    | `integer` | Results per page, `1`–`100`. Defaults to `10`                                                                                                                       |
| `team_id`      | Optional    | `integer` | Act on a team's storage instead of your own. See [Teams](/account/teams.md)                                                                                         |

## Response Attributes

#### data `list`

The matching workspaces. Each entry contains:

* **object\_storage\_name** `string`: The workspace name, used as `object_storage_name` everywhere else.
* **status** `string`: `Ready`, `Deleted`, or `Disabled`.
* **active** `boolean`: Whether the workspace is currently active.
* **charges** `float`: Cumulative cost incurred by the workspace.
* **type** `integer`: The storage plan type. Defaults to `1`.
* **location** `string`: Where the workspace is hosted, lowercased — for example `canada`.
* **provider** `string`: Identifies the storage backend serving the workspace.
* **team** `object`: The owning team — `id`, `name`, `role`, `permission` — or `null` for a personal workspace.
* **user** `object`: The owning user — `id`, `name`, `email`.

#### meta `dict`

Pagination details: **total\_count**, **page**, **limit**, and **total\_pages**.

#### status `string`

`success` or `failed`.

#### message `string`

A description of the result.

## Example

#### Request

```bash
curl -X GET '{API_URL}/object-storage/?space_status=Ready&page=1&limit=10' \
-H 'Authorization: Bearer {TOKEN}'
```

#### Response

```json
{
    "data": [
        {
            "object_storage_name": "research-datasets",
            "charges": 1.2043,
            "active": true,
            "status": "Ready",
            "type": 1,
            "location": "canada",
            "team": null,
            "user": {"id": 18, "name": "Test User", "email": "testemail@gmail.com"}
        }
    ],
    "meta": {"total_count": 1, "page": 1, "limit": 10, "total_pages": 1},
    "message": "user object storage successfully retrieved",
    "status": "success"
}
```

## See also

* [Create Storage Workspace](/api-reference/platform-api/list-workspaces/create-workspace.md)
* [Object Storage](/products/object-storage.md)