Interface GitHubUser

Represents a GitHub user or bot. This is the minimal user object embedded in other responses (e.g., repository owner, PR author).

interface GitHubUser {
    avatar_url: string;
    bio?: null | string;
    company?: null | string;
    created_at?: string;
    email: null | string;
    followers?: number;
    following?: number;
    html_url: string;
    id: number;
    location?: null | string;
    login: string;
    name: null | string;
    public_gists?: number;
    public_repos?: number;
    site_admin: boolean;
    type: "Organization" | "User" | "Bot";
    updated_at?: string;
}

Properties

avatar_url bio? company? created_at? email followers? following? html_url id location? login name public_gists? public_repos? site_admin type updated_at?

Properties

avatar_url

avatar_url: string

URL to the user's avatar image

Optionalbio

bio?: null | string

The user's biography

Optionalcompany

company?: null | string

The user's company affiliation

Optionalcreated_at

created_at?: string

ISO 8601 timestamp of account creation

email

email: null | string

Public email address, may be null

Optionalfollowers

followers?: number

Number of followers

Optionalfollowing

following?: number

Number of accounts the user follows

html_url

html_url: string

URL to the user's GitHub profile page

id

id: number

Unique numeric user ID

Optionallocation

location?: null | string

The user's location

login

login: string

The user's login name (e.g., 'octocat')

name

name: null | string

Display name, may be null for users who have not set one

Optionalpublic_gists

public_gists?: number

Number of public gists

Optionalpublic_repos

public_repos?: number

Number of public repositories

site_admin

site_admin: boolean

Whether the user is a GitHub site administrator

type

type: "Organization" | "User" | "Bot"

Account type

Optionalupdated_at

updated_at?: string

ISO 8601 timestamp of last profile update

Settings

Member Visibility

On This Page

Properties