Modrinth API Types - v1.1.0
    Preparing search index...

    Type Alias APIUser

    type APIUser = {
        auth_providers: string[] | null;
        avatar_url: string;
        badges: number;
        bio: string;
        created: Date;
        email: string | null;
        email_verified: boolean | null;
        github_id: null;
        has_password: boolean | null;
        has_totp: boolean | null;
        id: string;
        name: string | null;
        payout_data: APIUserPayoutData | null;
        role: UserRole;
        username: string;
    }
    Index

    Properties

    auth_providers avatar_url badges bio created email email_verified github_id has_password has_totp id name payout_data role username

    Properties

    auth_providers: string[] | null

    A list of authentication providers you have signed up for.

    Only displayed if requesting your own account.

    avatar_url: string

    The user’s avatar url.

    badges: number

    Any badges applicable to this user.

    In order from first to seventh bit, the current bits are:

    • (unused): 1n << 0n
    • EARLY_MODPACK_ADOPTER: 1n << 1n
    • EARLY_RESPACK_ADOPTER: 1n << 2n
    • EARLY_PLUGIN_ADOPTER: 1n << 3n
    • ALPHA_TESTER: 1n << 4n
    • CONTRIBUTOR: 1n << 5n
    • TRANSLATOR: 1n << 6n

    These are currently unused and undisplayed, and as such are subject to change.

    bio: string

    A description of the user.

    created: Date

    The time at which the user was created.

    email: string | null

    The user’s email.

    Only displayed if requesting your own account. Requires USER_READ_EMAIL PAT scope.

    email_verified: boolean | null

    Whether your email is verified.

    Only displayed if requesting your own account.

    github_id: null

    This is no longer public for security reasons and is always null.

    has_password: boolean | null

    Whether you have a password associated with your account.

    Only displayed if requesting your own account.

    has_totp: boolean | null

    Whether you have TOTP two-factor authentication connected to your account.

    Only displayed if requesting your own account.

    id: string

    The user’s ID.

    name: string | null

    The user’s display name.

    payout_data: APIUserPayoutData | null

    Various data relating to the user’s payouts status.

    Only displayed if requesting your own account.

    role: UserRole

    The user’s role.

    username: string

    The user’s username.

    Settings

    Member Visibility

    On This Page

    Properties