# Get workspace details

`GET https://app.clik.so/api/workspace/bootstrap`

> **In short:** Returns your workspace's plan, limits, usage, folders, tags and domains in one call. It is the quickest way to learn what a key can do.

## You need

* **API key permission:** `read`
* **Workspace role:** viewer or higher
* **Plan:** any plan, including Free

## Example

```bash
curl "https://app.clik.so/api/workspace/bootstrap" \
  -H "Authorization: Bearer $CLIKSO_API_KEY"
```

Response 200:

```json
{
  "status": 200,
  "success": true,
  "message": "Success",
  "data": {
    "workspace_id": "8a1f2c3d-4b5e-4f60-9a7b-1c2d3e4f5a6b",
    "profile": {
      "id": "c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f",
      "email": "asha@example.com",
      "display_name": "Asha Rao",
      "photo_url": "",
      "created_at": "2026-09-01T12:00:00.000Z"
    },
    "is_app_admin": false,
    "workspaces": [
      {
        "id": "8a1f2c3d-4b5e-4f60-9a7b-1c2d3e4f5a6b",
        "name": "Acme",
        "owner_id": "c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f",
        "plan_type": "starter",
        "subscription_status": "active",
        "created_at": "2026-09-01T12:00:00.000Z",
        "updated_at": "2026-10-01T12:00:00.000Z",
        "role": "admin",
        "access_state": null,
        "access_state_since": null,
        "is_default": true,
        "default_since": null
      }
    ],
    "usage": {
      "workspace_id": "8a1f2c3d-4b5e-4f60-9a7b-1c2d3e4f5a6b",
      "links_created_this_month": 42,
      "clicks_this_month": 1873,
      "ai_analytics_today": 0,
      "ai_slug_gens_today": 3,
      "last_reset_ai": "2026-10-09",
      "last_reset_monthly": "2026-10-01",
      "next_reset": "2026-11-01T00:00:00.000Z",
      "updated_at": "2026-10-09T09:30:00.000Z",
      "plan_key": "starter",
      "plan_links_limit": 500,
      "plan_domains_limit": 2,
      "is_simulated": false
    },
    "subscription": {
      "plan": "starter",
      "plan_name": "Starter",
      "period": "monthly",
      "currency": "USD",
      "status": "active",
      "limits": {
        "linksPerMonth": 500,
        "clicksPerMonth": 20000,
        "customDomains": 2,
        "retentionDays": 90,
        "folders": 6,
        "tags": 10,
        "teamSeats": 2,
        "aiAnalyticsPerDay": 20,
        "aiSlugsPerDay": 30
      },
      "features": {
        "passwordProtection": true,
        "customQr": true,
        "deviceTargeting": false,
        "geoTargeting": false,
        "abTesting": false,
        "customOg": true,
        "apiAccess": true
      }
    },
    "folders": [
      {
        "id": "6b7c8d9e-0f1a-4b2c-8d3e-4f5a6b7c8d9e",
        "name": "Campaigns",
        "created_at": "2026-10-01T08:00:00.000Z",
        "updated_at": "2026-10-01T08:00:00.000Z",
        "link_count": 12
      }
    ],
    "tags": [
      {
        "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "name": "launch",
        "color": "#3b82f6",
        "created_at": "2026-10-01T08:00:00.000Z",
        "updated_at": "2026-10-01T08:00:00.000Z",
        "link_count": 4
      }
    ],
    "domains": [],
    "members": {
      "members": [],
      "invitations": []
    }
  }
}
```

## Common errors

| Status | Code           | When                                                                  |
| ------ | -------------- | --------------------------------------------------------------------- |
| 401    | `UNAUTHORIZED` | The API key is missing, malformed or unknown.                         |
| 403    | `FORBIDDEN`    | The `Workspace-Id` header names a different workspace than the key's. |
| 429    | `RATE_LIMITED` | The key went over its per-minute request limit.                       |

## Good to know

* `workspace_id` is the key's own workspace. A key always works on that one workspace.
* `subscription.limits` uses `-1` for "no limit".
* With an API key, `workspaces` holds only the key's own workspace, pending invitations come without their `token`, and `subscription.subscription_id` is `null`.
* This is a large response. If you only need numbers, [Get usage](https://clik.so/docs/api/workspace/get-usage) is smaller.

---

Source: https://clik.so/docs/api/workspace/get-bootstrap