List workspaces

List workspaces accessible to the authenticated user.

Filtering: Instance-level users (Sys Admin, Account Manager, Admin, DPO Admin) see ALL workspaces. Company-level users (Company Admin, Company DPO) see workspaces in their company. Regular users see only workspaces where they are members.

Member Visibility: only OWNER role sees members. EDITOR and VIEWER roles do not see members.

Results ordered by creation date (newest first).

GET /api/v3/workspaces

List workspaces

cURL

curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/workspaces \
  --header 'Authorization: Bearer <token>'

200

{
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "workspace_type": "<string>",
      "document_upload_method": "<string>",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "members": {
        "users": [
          123
        ],
        "groups": [
          123
        ]
      },
      "user_role": "<string>"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page · integer

A page number within the paginated result set.

Response

200 - application/json

count · integer · required

Example:

123

results · object[] · required

Show child attributes

next · string<uri> | null

Example:

"http://api.example.org/accounts/?page=4"

previous · string<uri> | null

Example:

"http://api.example.org/accounts/?page=2"