@webitel/api-services
    Preparing search index...

    Type Alias ListGroupsParams

    type ListGroupsParams = {
        enabled?: boolean;
        fields?: string[];
        id?: string[];
        name?: string;
        page?: number;
        q?: string;
        size?: number;
        sort?: string[];
        type?: ListGroupsType;
    }
    Index

    Properties

    enabled? fields? id? name? page? q? size? sort? type?

    Properties

    enabled?: boolean

    Filter by only enabled group

    fields?: string[]

    Fields to be retrieved as a result.

    id?: string[]

    Filter by unique IDs.

    name?: string

    Filter by group name.

    Optionalpage

    page?: number

    Page number of result dataset records. offset = (page*size)

    q?: string

    Search term: group name; ? - matches any one character * - matches 0 or more characters

    size?: number

    Size count of records on result page. limit = (size++)

    sort?: string[]

    Sort the result according to fields.

    type?: ListGroupsType

    Filter by group type.

    • GROUP_TYPE_UNSPECIFIED: Default value
    • STATIC: Static group
    • DYNAMIC: Dynamic group

    Settings

    Member Visibility

    On This Page

    Properties