Skip to main content

Get Workspace by Id

GET 
/api/workspaces/:id/

Returns a single workspace by id.

Request​

Path Parameters

    id integerrequired

    A unique integer value identifying this workspace.

Responses​

Schema

    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
Loading...