Get Workspace Info

Returns resource counts, storage usage, and usage statistics for a specific workspace, including devices, variables, users, dashboards, reports, actions, alert rules, sites, and the last three months of data point and AI token consumption.

Endpoint

GET /rest/v1/workspaces/{wsuuid}/info

Headers

Header	Value
`Authorization`	`Bearer <YOUR_API_KEY>`
`Content-Type`	`application/json`

Path Parameters

Parameter	Type	Required	Description
`wsuuid`	String	Yes	Unique identifier of the workspace.

Example Request

GET /rest/v1/workspaces/01KXYZ123456789/info
Authorization: Bearer <YOUR_API_KEY>

Success Response

Status: 200 OK

{
  "data": {
    "devices_count": 2,
    "variables_count": 5,
    "users_count": 1,
    "dashboards_count": 1,
    "reports_count": 0,
    "schedule_actions_count": 0,
    "actions_count": 0,
    "alert_rules_count": 0,
    "sites_count": 1,
    "storage_usage": "0 MB",
    "monthly_usage": [
      {
        "month": "July",
        "year": 2026,
        "data_points_consumed": 3505,
        "ai_tokens_consumed": 0
      },
      {
        "month": "June",
        "year": 2026,
        "data_points_consumed": 0,
        "ai_tokens_consumed": 0
      },
      {
        "month": "May",
        "year": 2026,
        "data_points_consumed": 0,
        "ai_tokens_consumed": 0
      }
    ]
  },
  "meta": {
    "message": "Workspace info fetched successfully",
    "success": true
  }
}

Response Fields

Field	Description
`devices_count`	Effective device count for the workspace. This is calculated as the greater of the actual device count or the variable-based capacity (15 variables per device).
`variables_count`	Total number of variables configured in the workspace.
`users_count`	Total number of users with access to the workspace.
`dashboards_count`	Total number of dashboards in the workspace.
`reports_count`	Total number of reports configured.
`schedule_actions_count`	Total number of scheduled actions configured.
`actions_count`	Total number of actions configured.
`alert_rules_count`	Total number of alert rules configured.
`sites_count`	Total number of sites associated with the workspace.
`storage_usage`	Total storage consumed by files and attachments, returned as a human-readable value (for example, `128 MB`).
`monthly_usage`	Usage statistics for the current month and the previous two months.
`monthly_usage[].month`	Name of the month.
`monthly_usage[].year`	Year of the recorded usage.
`monthly_usage[].data_points_consumed`	Number of data points ingested during the month.
`monthly_usage[].ai_tokens_consumed`	Number of AI tokens consumed during the month.

Errors

HTTP Status	Description
400 Bad Request	The required `wsuuid` path parameter is missing or invalid.
401 Unauthorized	Authentication failed due to a missing or invalid API key.
404 Not Found	The specified workspace could not be found.