Get All Workspace Groups

GET 
/api/workspaces/:workspace_id/groups/

Returns current user's groups or all groups if the user is admin.

Request

Path Parameters

workspace_id stringrequired

Query Parameters

limit integer

Number of results to return per page.

offset integer

The initial index from which to return the results.

sort string

Possible values: [name, name:asc, name:desc]

Sort by name, allowing for :asc and :desc suffixes.

search string

Possible values: non-empty

Search within name and description

Responses

200

application/json

Schema

Schema

id integer
name stringrequired

Possible values: non-empty and <= 128 characters

description stringnullable

Possible values: <= 512 characters

members integer[]
members_only_in_this_group integer
is_default boolean

Example (from schema)

{
  "id": 0,
  "name": "string",
  "description": "string",
  "members": [
    0
  ],
  "members_only_in_this_group": 0,
  "is_default": true
}

400

Validation error response.

It produces a validation error schema like below.

{
    "field1": ["Validation error"],
    "non_field_errors": ["Sample non field validation error"]
}

401

No authentication found or authentication is not correct.

403

Specified path is not allowed

Permission evaluation:

Is Authenticated AND Is Not App AND ((Safe Permission AND Read Group Permission) OR (Workspace Context Permission AND Is Authenticated Workspace Admin)) AND Is Not Editor App Workspace Context

Descriptions:

Read Group Permission : Permitted to read Group if member of Group.

Is Not Editor App Workspace Context : Not available for editor type apps.

Workspace Context Permission : Workspace must be available to the User.

Is Authenticated Workspace Admin : Checks whether the user has admin rights to the workspace.

Is Authenticated : Allows access only to authenticated users.

Is Not App : Client must not be a VIKTOR app.

Safe Permission : Permitted to perform Safe operations (read)

Loading...