Get a list of workspaces.

Workspaces have three levels of access:

  • Unlisted workspace: is_public=False Only collaborators can see and modify this workspace.
  • Listed workspace: is_public=True This workspace has its public attributes (public description, "pinned" objects) visible to all users who have at least read workspaces permissions. Only collaborators can see the full workspace and modify it.
  • Public workspace: is_shared_with_all=True This is only set to True for the "Default public workspace", which is fully visible and can be modified by users who have at least read workspaces permissions.

Required permissions

  • read workspaces

Optional permissions

  • read intel-sets To read datasets attached to the workspaces

  • read entities To read entities pinned to the workspaces

  • read tasks To read discovery tasks associated to the workspaces

  • read discovery-rules To read discovery tasks associated to the workspaces

  • read tickets To read tickets attached to the workspaces

  • read users To read workspace collaborators

  • read groups To read workspace collaborator groups

  • read files To read workspace files

  • read workspace-comments To read workspace comments

Query Params
int32
≥ 1

Maximum number of items to be returned

int32
≥ 0

Return results starting from the specified (zero-based) index

string

Comma-separated list of fields to sort on. Prefix a field with the minus "-" sign if you intend to apply descending sorting to it

boolean

Set this parameter to false if you want to only retrieve the number of objects matching the query

string

Comma-separated list of attributes to be returned. Nested attributes are separated by dots - e.g. data.title

string

Filter by workspace name

string

Filter by workspace description

string

Filter by workspace public description

string

Filter by workspace type

boolean

Filter by archived state

boolean

Filter by shared with all users state

Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json