Workspace /workspace/{workspace-id}

Represents an individual workspace.

Reading

GET /workspace/{workspace-id} HTTP/1.1
Host: localhost:3000

Permissions

  • An access token with workspace_environment permission is required.
  • If access token points to an user, the current person must be attached to the workspace.
  • If access token points to a workspace, the workspace must be the current workspace.

Fields

Name Description Type

_id

The workspace ID.

string

name

The name of the workspace.

string

category

The category of the workspace.

string

settings

The settings of the workspace.

object

app_settings

The settings of the workspace apps.

object

admins

The admin users of the workspace.

object[]

user

The admin User ID.

User

perms

The admin permission.

enum{READ, MANAGE}

created_time

The date that indicates when the workspace was created.

date

updated_time

The date that indicates when the workspace was updated for the last time.

date

Publishing

You can't create workspaces by using the Nexty API. Please contact us if you want to add a new workspace to the Nexty Platform.

Updating

PUT /workspace/{workspace-id} HTTP/1.1
Host: localhost:3000

Permissions

  • An access token with manage_environment permission is required.
  • If access token points to an user, the current person must be an admin (with MANAGE permission) of the workspace.
  • If access token points to a workspace, the workspace must be the current workspace.

Fields

Name Description Type

name

The name of the workspace.

string

category

The category of the workspace.

string

settings

The settings of the workspace.

object

app_settings

The settings of the workspace apps.

object

Response

If successful :

{
    "success": true
}

Otherwise a relevant error message will be returned.

Deleting

You can't delete workspaces by using the Nexty API. Please contact us if you want to remove a workspace from the Nexty Platform.

Edges

Name Description

/admins

The admin users attached to the workspace.

/users

The users attached to the workspace.

/tags

The tags of the workspace.

/permissions

The permissions that the thirdparty has requested from the workspace.