Type Alias Groups

A result object when listing groups.

type Groups = {
    data?: Group[];
    links?: {
        next?: { href: string };
        prev?: { href: string };
        self: { href: string };
    };
    totalResults?: number;
}
Index

Properties

data? links? totalResults?

Properties

data?: Group[]

An array of groups.

links?: {
    next?: { href: string };
    prev?: { href: string };
    self: { href: string };
}
totalResults?: number

Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true.

Settings

Member Visibility

On This Page

Properties