Tsarr Documentation - v2.11.0
    Preparing search index...

    Type Alias GetUserData

    type GetUserData = {
        body?: never;
        path?: never;
        query?: {
            take?: number | null;
            skip?: number | null;
            sort?:
                | "created"
                | "updated"
                | "requests"
                | "displayname"
                | "usertype"
                | "role";
            sortDirection?: "asc"
            | "desc";
            q?: string;
            includeIds?: string;
        };
        url: "/user";
    }
    Index

    Properties

    body? path? query? url

    Properties

    Optionalbody

    body?: never
    path?: never
    query?: {
        take?: number | null;
        skip?: number | null;
        sort?:
            | "created"
            | "updated"
            | "requests"
            | "displayname"
            | "usertype"
            | "role";
        sortDirection?: "asc"
        | "desc";
        q?: string;
        includeIds?: string;
    }

    Type Declaration

    • Optionaltake?: number | null
    • Optionalskip?: number | null
    • Optionalsort?: "created" | "updated" | "requests" | "displayname" | "usertype" | "role"
    • OptionalsortDirection?: "asc" | "desc"

      Sort direction. When omitted, the server chooses the direction per sort field (e.g. displayname defaults to asc, requests/updated to desc).

    • Optionalq?: string
    • OptionalincludeIds?: string
    url: "/user"

    Settings

    Member Visibility

    On This Page

    Properties