kustomer-client
    Preparing search index...

    Type Alias GetUsersData

    type GetUsersData = {
        body?: never;
        path?: never;
        query?: {
            deleted?: boolean;
            email?: string;
            pending?: boolean;
            userType?: "user" | "machine" | "limited";
        };
        url: "/users";
    }
    Index

    Properties

    body? path? query? url

    Properties

    Optionalbody

    body?: never
    path?: never
    query?: {
        deleted?: boolean;
        email?: string;
        pending?: boolean;
        userType?: "user" | "machine" | "limited";
    }

    Type declaration

    • Optionaldeleted?: boolean

      Activation status of user. true returns only deactivated users. false returns only active users.

    • Optionalemail?: string

      User email address.

    • Optionalpending?: boolean

      Invitation status of user. true returns only users with a pending invitation. false returns only active users.

    • OptionaluserType?: "user" | "machine" | "limited"

      User type. Options: user for full users, machine for a machine user or API user, and limited for collaborator user.

    url: "/users"

    Settings

    Member Visibility

    On This Page

    Properties