Interface NotificationsParams

Query parameters for listing notifications.

See

https://docs.github.com/en/rest/activity/notifications#list-notifications-for-the-authenticated-user

interface NotificationsParams {
    all?: boolean;
    before?: string;
    page?: number;
    participating?: boolean;
    per_page?: number;
    since?: string;
}

Hierarchy (View Summary)

Properties

all? before? page? participating? per_page? since?

Properties

Optionalall

all?: boolean

If true, returns all notifications including already-read ones

Optionalbefore

before?: string

Only show notifications updated before this ISO 8601 date

Optionalpage

page?: number

Page number to retrieve (1-based). Use nextPage from the previous response to paginate forward.

Optionalparticipating

participating?: boolean

If true, only returns notifications the user is directly participating in or mentioned in

Optionalper_page

per_page?: number

Maximum number of results per page. GitHub default is 30, maximum is 100.

Optionalsince

since?: string

Only show notifications updated after this ISO 8601 date

Settings

Member Visibility

On This Page

Properties