Skip to main content

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

    Possible values: >= 1

    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

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
Loading...