Get All Workspaces

GET 
/api/workspaces/

List the workspaces for the current user, depending on user role and access.

Request

Query Parameters

limit integer

Number of results to return per page.

offset integer

The initial index from which to return the results.

detail_level string

Possible values: [minimal, basic, full]

Default value: full

Response detail level. See :ref:Response detail levels <response detail levels target> for detail of detail levels.

include_development boolean

Set to True for gathering all individual development workspaces of users. Requires org admin permission.

include_archived boolean

Whether or not to include archived workspaces. Requires org admin permission.

visibility string[]

Possible values: [INTERNAL, PRIVATE, DEVELOPMENT, PUBLIC]

Filter on workspace visibility. Can be one of: INTERNAL, PRIVATE, DEVELOPMENT, PUBLIC.

is_dev boolean

Fetches only the development workspaces if true.

archived boolean

Fetches only the archived workspaces if true.

app integer[]

Filter on app ID.

label integer[]

Filter on label ID.

project integer

Possible values: >= 1

Filter on project ID.

sort string

Possible values: [name, name:asc, name:desc, created_at, created_at:asc, created_at:desc, views, views:asc, views:desc, views_last_30_days, views_last_30_days:asc, views_last_30_days:desc, user_last_visit, user_last_visit:asc, user_last_visit:desc]

Sort by name | created_at | views | views_last_30_days | user_last_visit, allowing for :asc and :desc suffixes.

search string

Possible values: non-empty

Allow for fuzzy name/description match.

Responses

200

application/json

Schema

Schema

count integerrequired

Count of all the objects in the result set.

next string

Next url.

previous string

Previous url.

results

object[]

required

Array [

id integer

name stringrequired

Possible values: non-empty and <= 128 characters

The name of the workspace.

slug slug

Possible values: non-empty, Value must match regular expression ^[-a-zA-Z0-9_]+$

The unique slug representation of the workspace if it is public.

description string

A description about the workspace and its usage.

created_at date-time

The workspace creation date. The value is in ISO 8601 format.

updated_at date-time

The date the workspace was last updated. The value is in ISO 8601 format.

visibility string

Possible values: [INTERNAL, PRIVATE]

type string

Possible values: [PROJECT, DEVELOPMENT, PUBLIC, TEST]

app

object

id integer

name string

readable_name string

Possible values: non-empty

Human-readable app name.

app_builder

object

id integer

conversation_id integernullablerequired

The id of the Conversation.

current_preview_code_revision_id integernullablerequired

The id of the in-preview CodeRevision.

current_active_code_revision_id integernullablerequired

The id of the currently active CodeRevision.

previous_active_code_revision_id integernullablerequired

The id of the previously active CodeRevision.

first_created_code_revision_id integernullablerequired

The id of the first created CodeRevision.

latest_created_code_revision_id integernullablerequired

The id of the latest created CodeRevision.

latest_code_revision_id integernullablerequired

DEPRECATED

app_version

object

id integer

tag string

Possible values: non-empty

Unique version tag for the application.

is_conflicted boolean

status string

Possible values: [CREATED, UPLOADING, PACKING, CHECKING, PUBLISHING, PUBLISHED, ERROR, ERROR_WITH_ACTION_REQUIRED]

Status of the app version. It can be one of CREATED, UPLOADING, PACKING, CHECKING, PUBLISHING, PUBLISHED, ERROR, ERROR_WITH_ACTION_REQUIRED

app_type string

Possible values: [tree, simple, editor]

Shows the application type. It can be one of tree,simple,editor

sdk_version string

oauth2_integrations string

python_version string

Possible values: non-empty

Python version of the version. Supported versions are: 3.7, 3.8, 3.9, 3.10, 3.11

connector_version string

Possible values: non-empty

Connector version.

created_at date-time

App version creation date. The value is in ISO 8601 format.

created_by_type stringrequired

Possible values: [User, CI]

Type of the instance creating. It can be one of User, CI

created_by_instance integerrequired

Returns the creating instance id.

created_by_context object

Default value: [object Object]

Context dictionary which is provided in publishing flow.

progress object[]nullable

Progress steps of the app version statuses.This field returns list of dictionary having name, detail, status, started_at, and finished_at. It can be one of AWAITING, STARTED, FINISHED, FINISHED_WITH_WARNINGS, ERROR

errors

object[]

Array [

code string

Possible values: non-empty

The error code. Check the codes reference for more information.

context object

Extra information related to the context of the error. Check the codes reference for more information.

]

image stringnullable

Possible values: non-empty

An image (b64 encoded, <1MB) visible on the workspace card.

is_dev boolean

Returns whether the workspace is dev.

owner integer

Returns the owner id of a development workspace. This field is null when is_dev is false.

is_initialized boolean

Returns whether the workspace is initialized with entity types.

is_archived boolean

Returns whether the workspace is archived.

is_active boolean

Shows whether runners are ready for jobs.

labels

object[]

Array [

id integer

name stringrequired

Possible values: non-empty and <= 30 characters

description string

Possible values: <= 100 characters

color stringrequired

Possible values: non-empty and <= 6 characters

number_of_apps integer

number_of_workspaces integer

]

project

object

id integer

name stringrequired

Possible values: non-empty and <= 128 characters

description string

Possible values: <= 512 characters

visibility stringrequired

Possible values: [INTERNAL, PRIVATE]

default_group integer

user_last_visit date-time

Timestamp that this workspace was last used by the requesting user.

nr_views integer

The calculated total daily unique sessions in case of PROJECT workspace, and the number of views (count editor sessions) in case of PUBLIC workspace

nr_views_last_30_days integer

The calculated total daily unique sessions in case of PROJECT workspace, and the number of views (count editor sessions) in case of PUBLIC workspace (in the last 30 days).

target_total_users integernullable

Possible values: <= 2147483647

Target total users.

target_monthly_active_users integernullable

Possible values: <= 2147483647

Target monthly active users.

target_daily_active_users_per_month integernullable

Possible values: <= 2147483647

Target daily active users.

start_entity_id integernullable

]

Example (from schema)

{
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
    {
      "id": 0,
      "name": "string",
      "slug": "string",
      "description": "string",
      "created_at": "2025-11-07T16:05:09.027Z",
      "updated_at": "2025-11-07T16:05:09.027Z",
      "visibility": "INTERNAL",
      "type": "PROJECT",
      "app": {
        "id": 0,
        "name": "string",
        "readable_name": "string"
      },
      "app_builder": {
        "id": 0,
        "conversation_id": 0,
        "current_preview_code_revision_id": 0,
        "current_active_code_revision_id": 0,
        "previous_active_code_revision_id": 0,
        "first_created_code_revision_id": 0,
        "latest_created_code_revision_id": 0,
        "latest_code_revision_id": 0
      },
      "app_version": {
        "id": 0,
        "tag": "string",
        "is_conflicted": true,
        "status": "CREATED",
        "app_type": "tree",
        "sdk_version": "string",
        "oauth2_integrations": "string",
        "python_version": "string",
        "connector_version": "string",
        "created_at": "2025-11-07T16:05:09.027Z",
        "created_by_type": "User",
        "created_by_instance": 0,
        "created_by_context": {},
        "progress": [
          {}
        ]
      },
      "errors": [
        {
          "code": "string",
          "context": {}
        }
      ],
      "image": "string",
      "is_dev": true,
      "owner": 0,
      "is_initialized": true,
      "is_archived": true,
      "is_active": true,
      "labels": [
        {
          "id": 0,
          "name": "string",
          "description": "string",
          "color": "string",
          "number_of_apps": 0,
          "number_of_workspaces": 0
        }
      ],
      "project": {
        "id": 0,
        "name": "string",
        "description": "string",
        "visibility": "INTERNAL"
      },
      "default_group": 0,
      "user_last_visit": "2025-11-07T16:05:09.027Z",
      "nr_views": 0,
      "nr_views_last_30_days": 0,
      "target_total_users": 0,
      "target_monthly_active_users": 0,
      "target_daily_active_users_per_month": 0,
      "start_entity_id": 0
    }
  ]
}

400

Validation error response.

It produces a validation error schema like below.

{
    "field1": ["Validation error"],
    "non_field_errors": ["Sample non field validation error"]
}

401

No authentication found or authentication is not correct.

403

Specified path is not allowed

Permission evaluation:

Is Authenticated AND Is Not App

Descriptions:

Is Authenticated : Allows access only to authenticated users.

Is Not App : Client must not be a VIKTOR app.

Loading...