List Workspaces

Returns a paginated list of all workspaces that belong to the authenticated organization.

Endpoint

GET /rest/v1/workspaces

Headers

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

Query Parameters

Parameter	Type	Required	Description
`page`	Integer	No	Page number to retrieve. Default: `1`.
`per_page`	Integer	No	Number of workspaces to return per page. Default: `20`. Maximum: `50`.

Example Request

GET /rest/v1/workspaces?page=1&per_page=20
Authorization: Bearer <YOUR_API_KEY>

Success Response

Status: 200 OK

{
  "data": [
    {
      "uuid": "01kxcxpcgvdm1pacpfv1wxqqeh",
      "name": "Manufacturing Plant",
      "time_zone": "Asia/Calcutta",
      "created_at": "2026-07-13T05:02:45.272466Z",
      "updated_at": "2026-07-13T05:09:19.761363Z",
      "active": false,
      "description": "Centralized workspace for manufacturing devices, energy monitoring, and machine analytics.",
      "allow_manage_users": true,
      "currency_code": "INR",
      "enable_iot": true,
      "primary_language": "english",
      "secondary_language": ""
    },
    {
      "uuid": "01kx2ytcgtqws9505bqwcnpnhw",
      "name": "Production Plant",
      "time_zone": "Asia/Calcutta",
      "created_at": "2026-07-09T08:10:00.595077Z",
      "updated_at": "2026-07-09T08:17:47.047219Z",
      "active": true,
      "description": "Production workspace for IoT devices and monitoring.",
      "allow_manage_users": true,
      "currency_code": "INR",
      "enable_iot": true,
      "primary_language": "english",
      "secondary_language": ""
    }
  ],
  "meta": {
    "count": 2,
    "message": "Workspace list fetched successfully",
    "page": 1,
    "per_page": 20,
    "success": true
  }
}

Response Fields

Field	Description
`uuid`	Unique identifier of the workspace.
`name`	Name of the workspace.
`description`	Description of the workspace.
`time_zone`	Configured IANA time zone.
`currency_code`	Configured ISO currency code.
`active`	Indicates whether the workspace is active.
`allow_manage_users`	Indicates whether user management is enabled for the workspace.
`enable_iot`	Indicates whether IoT features are enabled for the workspace.
`primary_language`	Primary language configured for the workspace.
`secondary_language`	Secondary language configured for the workspace.
`created_at`	Timestamp when the workspace was created (UTC).
`updated_at`	Timestamp of the most recent update (UTC).