# List your tenant workspaces

`GET /v1/workspaces`

Requires an API key with the `workspaces:manage` scope. [About keys and scopes](/docs/api/authentication)

Partner keys only. Newest first. Results are cursor-paginated: pass `meta.pagination.nextCursor` back as `cursor` until it comes back `null`.

## Query parameters

- `limit` (integer, optional, min > 0, max 100, default `20`)
- `cursor` (string, optional, 1–2048 characters)

## Returns

Returns `200 OK` with a list of `Workspace` objects in `data`, and the next page's cursor in `meta` (see [pagination](/docs/api/pagination)). Otherwise returns an error; [Errors](/docs/api/errors) lists every code and which to retry.

- `id` (string, required, uuid)
- `externalId` (string, required) — Your own id for the tenant.
- `name` (string, required)
- `country` (string, required, 2–2 characters) — Two-letter ISO 3166-1 country code.
- `timezone` (string, required) — IANA timezone; decides local-time sends and report days.
- `status` (string, required, one of `active`, `suspended`, `deleting`) — `suspended` refuses every send in the workspace until it is resumed; `deleting` refuses them too, and the workspace is purged unless the deletion is cancelled.
- `suspendedAt` (string | null, required, date-time) — When it was suspended; null if not.
- `deletionRequestedAt` (string | null, required, date-time) — When deletion was asked for; null if not.
- `createdAt` (string, required, date-time)

## Example

```bash
curl https://api.kirora.io/v1/workspaces \
  -H "Authorization: Bearer $KIRORA_API_KEY"
```

Response `200`:

```json
{
  "data": [
    {
      "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
      "externalId": "user_8812",
      "name": "Weekend specials",
      "country": "GB",
      "timezone": "Europe/London",
      "status": "active",
      "suspendedAt": "2030-03-14T09:30:00Z",
      "deletionRequestedAt": "2030-03-14T09:30:00Z",
      "createdAt": "2030-03-14T09:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    }
  }
}
```