pl-api
    Preparing search index...

    Interface AdminGetAccountsParams

    interface AdminGetAccountsParams {
        by_domain?: string;
        display_name?: string;
        email?: string;
        invited_by?: string;
        ip?: string;
        limit?: number;
        max_id?: string;
        min_id?: string;
        origin?: "local" | "remote";
        permissions?: "staff";
        role_ids?: string[];
        since_id?: string;
        status?: "suspended" | "pending" | "disabled" | "silenced" | "active";
        username?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    by_domain? display_name? email? invited_by? ip? limit? max_id? min_id? origin? permissions? role_ids? since_id? status? username?

    Properties

    by_domain?: string

    String. Filter by the given domain

    display_name?: string

    String. Search for the given display name

    email?: string

    String. Lookup a user with this email

    invited_by?: string

    String. Lookup users invited by the account with this ID.

    ip?: string

    String. Lookup users with this IP address

    limit?: number

    Integer. Maximum number of results to return.

    max_id?: string

    String. All results returned will be lesser than this ID. In effect, sets an upper bound on results.

    min_id?: string

    String. Returns results immediately newer than this ID. In effect, sets a cursor at this ID and paginates forward.

    origin?: "local" | "remote"

    String. Filter for local or remote accounts.

    permissions?: "staff"

    String. Filter for accounts with staff permissions (users that can manage reports).

    role_ids?: string[]

    Array of String. Filter for users with these roles.

    since_id?: string

    String. All results returned will be greater than this ID. In effect, sets a lower bound on results.

    status?: "suspended" | "pending" | "disabled" | "silenced" | "active"

    String. Filter for active, pending, disabled, silenced, or suspended accounts.

    username?: string

    String. Search for the given username.

    Settings

    Member Visibility

    On This Page

    Properties