Skip to main content

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.

    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.

    app integer[]

    Filter on app ID.

    label integer[]

    Filter on label ID.

    sort string

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

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

    search string

    Possible values: non-empty

    Allow for fuzzy name/description match.

Responses​

Schema

    count integerrequired

    Count of all the objects in the result set.

    results

    object

    required

    count integerrequired
    next urinullable
    previous urinullable

    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 stringrequired

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

    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
    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. It can be either user object(id, name, first_name, last_name, email) or CI object(id, name)

    progress string

    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

    app

    object

    id integer
    name string

    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

  • ]

    • default_group integer
    nr_views integer

    The calculated total daily unique sessions in case of internal/private workspace, and the number of views (count editor sessions) in case of public workspace

  • ]

Loading...