Workspaces

Workspaces are used to divide up your organization into sub-categories such as departments. They can also be used to set up e.g. 'dev' and 'prod' workspaces for environment promotion.

List Workspaces

Lists all workspaces the token has access to i.e. will return all workspaces from the Tray Organization if the Org scope token is used, a single workspace for the workspace scoped token.

Response Examples

{
  "elements": [
    {
      "id": "string",
      "name": "string",
      "type": null,
      "description": "string",
      "monthlyTaskLimit": 0
    }
  ],
  "pageInfo": {
    "startCursor": "string",
    "endCursor": "string",
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

Get Workspace

Gets a workspace by Id.

Response Examples

{
  "id": "string",
  "name": "string",
  "type": null,
  "description": "string",
  "monthlyTaskLimit": 0
}

List Workspace Roles

Get Workspace Roles

Response Examples

{
  "elements": [
    {
      "id": "string",
      "name": "string",
      "type": null,
      "description": "string",
      "monthlyTaskLimit": 0
    }
  ],
  "pageInfo": {
    "startCursor": "string",
    "endCursor": "string",
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

List Users from a Workspace

List all users in the workspace

Response Examples

{
  "elements": [
    {
      "id": "string",
      "name": "string",
      "type": null,
      "description": "string",
      "monthlyTaskLimit": 0
    }
  ],
  "pageInfo": {
    "startCursor": "string",
    "endCursor": "string",
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

Add User to Workspace

Adds a user to a workspace

Request Examples

{
  "userId": "string",
  "roleId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response Examples

{}

Get Workspace User by id

Get workspace user by id

Response Examples

{
  "workspaceId": "string",
  "id": "string",
  "email": "string",
  "accountType": null,
  "role": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Update User's Workspace Role

Updates the role of a user in a workspace

Request Examples

{
  "roleId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response Examples

{}

Remove User from Workspace

Removes a user from a workspace

Response Examples

{}