List users's notification threads on a specific repo

GET

/repos/{owner}/{repo}/notifications

notification

Response Example

[
    {
        "id": 0,
        "pinned": true,
        "repository": {
            "allow_merge_commits": true,
            "allow_rebase": true,
            "allow_rebase_explicit": true,
            "allow_squash_merge": true,
            "archived": true,
            "avatar_url": "string",
            "clone_url": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "default_branch": "string",
            "default_merge_style": "string",
            "description": "string",
            "empty": true,
            "external_tracker": {
                "external_tracker_format": "string",
                "external_tracker_style": "string",
                "external_tracker_url": "string"
            },
            "external_wiki": {
                "external_wiki_url": "string"
            },
            "fork": true,
            "forks_count": 0,
            "full_name": "string",
            "has_issues": true,
            "has_projects": true,
            "has_pull_requests": true,
            "has_wiki": true,
            "html_url": "string",
            "id": 0,
            "ignore_whitespace_conflicts": true,
            "internal": true,
            "internal_tracker": {
                "allow_only_contributors_to_track_time": true,
                "enable_issue_dependencies": true,
                "enable_time_tracker": true
            },
            "mirror": true,
            "mirror_interval": "string",
            "name": "string",
            "open_issues_count": 0,
            "open_pr_counter": 0,
            "original_url": "string",
            "owner": {
                "active": true,
                "avatar_url": "string",
                "created": "2019-08-24T14:15:22Z",
                "description": "string",
                "email": "user@example.com",
                "followers_count": 0,
                "following_count": 0,
                "full_name": "string",
                "id": 0,
                "is_admin": true,
                "language": "string",
                "last_login": "2019-08-24T14:15:22Z",
                "location": "string",
                "login": "string",
                "prohibit_login": true,
                "restricted": true,
                "starred_repos_count": 0,
                "visibility": "string",
                "website": "string"
            },
            "parent": {},
            "permissions": {
                "admin": true,
                "pull": true,
                "push": true
            },
            "private": true,
            "release_counter": 0,
            "size": 0,
            "ssh_url": "string",
            "stars_count": 0,
            "template": true,
            "updated_at": "2019-08-24T14:15:22Z",
            "watchers_count": 0,
            "website": "string"
        },
        "subject": {
            "latest_comment_url": "string",
            "state": "string",
            "title": "string",
            "type": "string",
            "url": "string"
        },
        "unread": true,
        "updated_at": "2019-08-24T14:15:22Z",
        "url": "string"
    }
]

Request

Path Params

owner

string

required

owner of the repo

repo

string

required

name of the repo

Query Params

all

string

optional

If true, show notifications marked as read. Default value is false

status-types

array[string]

optional

Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned

subject-type

array[string]

optional

filter notifications by subject type

since

string

optional

Only show notifications updated after the given time. This is a timestamp in RFC 3339 format

before

string

optional

Only show notifications updated before the given time. This is a timestamp in RFC 3339 format

page

integer

optional

page number of results to return (1-based)

limit

integer

optional

page size of results

Responses

🟢200OK

application/json

Body

array of:

integer <int64>

optional

pinned

boolean

optional

repository

object (Repository)

optional

Repository represents a repository

allow_merge_commits

boolean

optional

allow_rebase

boolean

optional

allow_rebase_explicit

boolean

optional

allow_squash_merge

boolean

optional

archived

boolean

optional

avatar_url

string

optional

clone_url

string

optional

created_at

string <date-time>

optional

default_branch

string

optional

default_merge_style

string

optional

description

string

optional

empty

boolean

optional

external_tracker

object (ExternalTracker)

optional

ExternalTracker represents settings for external tracker

external_wiki

object (ExternalWiki)

optional

ExternalWiki represents setting for external wiki

fork

boolean

optional

forks_count

integer <int64>

optional

full_name

string

optional

has_issues

boolean

optional

has_projects

boolean

optional

has_pull_requests

boolean

optional

has_wiki

boolean

optional

html_url

string

optional

integer <int64>

optional

ignore_whitespace_conflicts

boolean

optional

internal

boolean

optional

internal_tracker

object (InternalTracker)

optional

InternalTracker represents settings for internal tracker

mirror

boolean

optional

mirror_interval

string

optional

name

string

optional

open_issues_count

integer <int64>

optional

open_pr_counter

integer <int64>

optional

original_url

string

optional

owner

object (User)

optional

User represents a user

parent

object (Repository)

optional

Repository represents a repository

permissions

object (Permission)

optional

Permission represents a set of permissions

private

boolean

optional

release_counter

integer <int64>

optional

size

integer <int64>

optional

ssh_url

string

optional

stars_count

integer <int64>

optional

template

boolean

optional

updated_at

string <date-time>

optional

watchers_count

integer <int64>

optional

website

string

optional

subject

object (NotificationSubject)

optional

NotificationSubject contains the notification subject (Issue/Pull/Commit)

latest_comment_url

string

optional

state

string

optional

StateType issue state type

title

string

optional

type

string

optional

NotifySubjectType represent type of notification subject

url

string

optional

unread

boolean

optional

updated_at

string <date-time>

optional

url

string

optional

Modified at 2022-09-10 23:12:52

Mark notification thread as read by ID

Mark notification threads as read, pinned or unread on a specific repo