1. API Operations
  2. Get workspaces

Deprecated

You are viewing a deprecated version of our API Reference. Please visit the up-to-date documentation.

Get workspaces

This operation returns the list of workspaces belonging to the current user, including their names.


Request

Parameters
Parameter
op
Type
string
required
true

Get the list of workspaces. The value is "get_workspaces".

Parameter
limit
Type
integer
required
true

Limit the number of returned workspaces.

{
  "op": "get_workspaces",
  "limit": 4
}

Response

Attributes
Attribute
op_status
Type
string

The status of the operation. The value can "success" or "fail".

Attribute
workspaces
Type
array

The list of workspaces for the current user. Returned in case of a successful operation.

Attribute
error
Type
string

Error message. Returned in case of a failed operation. The value is: "invalid workspace".

{
  "op_status": "success",
  "workspaces": [
    {
      "id": 42809779,
      "name": "My Workspace"
    },
    {
      "id": 73878548,
      "name": "VPN"
    },
    {
      "id": 36489826,
      "name": "Pentest firstexample.org"
    },
    {
      "id": 19939241,
      "name": "Pentest otherexample.org"
    }
  ]
}