List workspaces

Enterprise Only

This endpoint is only available in the Enterprise package and requires the authenticated user to be a Super Admin.

Method: GET

URL: https://example.com/<MIXPOST_CORE_PATH>/api/panel/workspaces

Authorization: Bearer <token>

Query Parameters:

Key	Format	Required	Description
`keyword`	string	optional	Search workspaces by name
`subscription_status`	string	optional	Filter by subscription status: `active`, `trialing`, `past_due`, `paused`, `canceled`, `incomplete`
`free`	-	optional	Filter workspaces with free generic subscription. No value needed, just include the parameter.
`access_status`	string or array	optional	Filter by access status: `subscription`, `unlimited`, `locked`
`exclude`	string or array	optional	Exclude workspaces by UUID

Response:

{
  "data": [
    {
      "uuid": "3bbd0951-5b04-432b-b2a0-688588b0720e",
      "name": "My Workspace",
      "hex_color": "#6366f1",
      "owner_id": 1,
      "owner": {
        "id": 1,
        "name": "John Doe",
        "email": "john@example.com"
      },
      "access_status": "subscription",
      "created_at": "Jan 15, 2025 10:30 AM",
      "subscriptions": [
        {
          "name": "default",
          "platform_subscription_id": "sub_1234567890",
          "platform_plan_id": "price_1234567890",
          "plan": {
            "id": 1,
            "name": "Pro Plan",
            "amount": 1999,
            "cycle": "monthly"
          },
          "status": "active",
          "recurring": "monthly",
          "trial_ends_at": null,
          "paused_from": null,
          "ends_at": null
        }
      ],
      "generic_subscription": {
        "name": null,
        "free": false,
        "trial_ends_at": null,
        "has_trial": false,
        "has_expired_trial": false,
        "remaining_trial_days": 0
      }
    }
  ],
  "links": {
    "first": "https://example.com/mixpost/api/panel/workspaces?page=1",
    "last": "https://example.com/mixpost/api/panel/workspaces?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 20,
    "to": 1,
    "total": 1
  }
}

{
  "message": "Unauthenticated."
}

{
  "message": "Access forbidden."
}