List issue events for a repository

GET

/repos/{owner}/{repo}/issues/events

Lists events for a repository.

API method documentation

Parameters

Path Parameters

owner

required

string

The account owner of the repository. The name is not case sensitive.

repo

required

string

The name of the repository without the .git extension. The name is not case sensitive.

Query Parameters

per_page

integer

default: 30

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

page

integer

default: 1

The page number of the results to fetch. For more information, see “Using pagination in the REST API.”

Responses

200

Response

Media type application/json

Array<object>

Issue Event

Issue Event

object

id

required

integer format: int64

node_id

required

string

url

required

string format: uri

actor

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

event

required

string

commit_id

required

string

nullable

commit_url

required

string

nullable

created_at

required

string format: date-time

issue

Issue

Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.

object

id

required

integer format: int64

node_id

required

string

url

required

URL for the issue

string format: uri

repository_url

required

string format: uri

labels_url

required

string

comments_url

required

string format: uri

events_url

required

string format: uri

html_url

required

string format: uri

number

required

Number uniquely identifying the issue within its repository

integer

state

required

State of the issue; either ‘open’ or ‘closed’

string

state_reason

The reason for the current state

string

nullable

Allowed values: completed reopened not_planned duplicate

title

required

Title of the issue

string

body

Contents of the issue

string

nullable

user

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

labels

required

Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository

Array

One of:

string

string

object

object

id

integer format: int64

node_id

string

url

string format: uri

name

string

description

string

nullable

color

string

nullable

default

boolean

assignee

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

assignees

Array<object>

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

milestone

required

Milestone

A collection of related issues and pull requests.

object

url

required

string format: uri

html_url

required

string format: uri

labels_url

required

string format: uri

id

required

integer

node_id

required

string

number

required

The number of the milestone.

integer

state

required

The state of the milestone.

string

default: open

Allowed values: open closed

title

required

The title of the milestone.

string

description

required

string

nullable

creator

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

open_issues

required

integer

closed_issues

required

integer

created_at

required

string format: date-time

updated_at

required

string format: date-time

closed_at

required

string format: date-time

nullable

due_on

required

string format: date-time

nullable

locked

required

boolean

active_lock_reason

string

nullable

comments

required

integer

pull_request

object

merged_at

string format: date-time

nullable

diff_url

required

string format: uri

nullable

html_url

required

string format: uri

nullable

patch_url

required

string format: uri

nullable

url

required

string format: uri

nullable

closed_at

required

string format: date-time

nullable

created_at

required

string format: date-time

updated_at

required

string format: date-time

draft

boolean

closed_by

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

body_html

string

body_text

string

timeline_url

string format: uri

type

Issue Type

The type assigned to the issue. This is only present for issues in repositories where issue types are supported.

object

id

required

The unique identifier of the issue type.

integer

node_id

required

The node identifier of the issue type.

string

name

required

The name of the issue type.

string

description

required

The description of the issue type.

string

nullable

color

The color of the issue type.

string

nullable

Allowed values: gray blue green yellow orange red pink purple

created_at

The time the issue type created.

string format: date-time

updated_at

The time the issue type last updated.

string format: date-time

is_enabled

The enabled state of the issue type.

boolean

repository

Repository

A repository on GitHub.

object

id

required

Unique identifier of the repository

integer format: int64

node_id

required

string

name

required

The name of the repository.

string

full_name

required

string

license

required

License Simple

License Simple

object

key

required

string

name

required

string

url

required

string format: uri

nullable

spdx_id

required

string

nullable

node_id

required

string

html_url

string format: uri

forks

required

integer

permissions

object

admin

required

boolean

pull

required

boolean

triage

boolean

push

required

boolean

maintain

boolean

owner

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

private

required

Whether the repository is private or public.

boolean

html_url

required

string format: uri

description

required

string

nullable

fork

required

boolean

url

required

string format: uri

archive_url

required

string

assignees_url

required

string

blobs_url

required

string

branches_url

required

string

collaborators_url

required

string

comments_url

required

string

commits_url

required

string

compare_url

required

string

contents_url

required

string

contributors_url

required

string format: uri

deployments_url

required

string format: uri

downloads_url

required

string format: uri

events_url

required

string format: uri

forks_url

required

string format: uri

git_commits_url

required

string

git_refs_url

required

string

git_tags_url

required

string

git_url

required

string

issue_comment_url

required

string

issue_events_url

required

string

issues_url

required

string

keys_url

required

string

labels_url

required

string

languages_url

required

string format: uri

merges_url

required

string format: uri

milestones_url

required

string

notifications_url

required

string

pulls_url

required

string

releases_url

required

string

ssh_url

required

string

stargazers_url

required

string format: uri

statuses_url

required

string

subscribers_url

required

string format: uri

subscription_url

required

string format: uri

tags_url

required

string format: uri

teams_url

required

string format: uri

trees_url

required

string

clone_url

required

string

mirror_url

required

string format: uri

nullable

hooks_url

required

string format: uri

svn_url

required

string format: uri

homepage

required

string format: uri

nullable

language

required

string

nullable

forks_count

required

integer

stargazers_count

required

integer

watchers_count

required

integer

size

required

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

integer

default_branch

required

The default branch of the repository.

string

open_issues_count

required

integer

is_template

Whether this repository acts as a template that can be used to generate new repositories.

boolean

topics

Array<string>

has_issues

required

Whether issues are enabled.

boolean

default: true

has_projects

required

Whether projects are enabled.

boolean

default: true

has_wiki

required

Whether the wiki is enabled.

boolean

default: true

has_pages

required

boolean

has_downloads

required

Whether downloads are enabled.

boolean

default: true

has_discussions

Whether discussions are enabled.

boolean

has_pull_requests

Whether pull requests are enabled.

boolean

default: true

pull_request_creation_policy

The policy controlling who can create pull requests: all or collaborators_only.

string

Allowed values: all collaborators_only

archived

required

Whether the repository is archived.

boolean

disabled

required

Returns whether or not this repository disabled.

boolean

visibility

The repository visibility: public, private, or internal.

string

default: public

pushed_at

required

string format: date-time

nullable

created_at

required

string format: date-time

nullable

updated_at

required

string format: date-time

nullable

allow_rebase_merge

Whether to allow rebase merges for pull requests.

boolean

default: true

temp_clone_token

string

allow_squash_merge

Whether to allow squash merges for pull requests.

boolean

default: true

allow_auto_merge

Whether to allow Auto-merge to be used on pull requests.

boolean

delete_branch_on_merge

Whether to delete head branches when pull requests are merged

boolean

allow_update_branch

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

boolean

use_squash_pr_title_as_default

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

boolean

squash_merge_commit_title

The default value for a squash merge commit title:

• PR_TITLE - default to the pull request’s title.
• COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).

string

Allowed values: PR_TITLE COMMIT_OR_PR_TITLE

squash_merge_commit_message

The default value for a squash merge commit message:

• PR_BODY - default to the pull request’s body.
• COMMIT_MESSAGES - default to the branch’s commit messages.
• BLANK - default to a blank commit message.

string

Allowed values: PR_BODY COMMIT_MESSAGES BLANK

merge_commit_title

The default value for a merge commit title.

• PR_TITLE - default to the pull request’s title.
• MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).

string

Allowed values: PR_TITLE MERGE_MESSAGE

merge_commit_message

The default value for a merge commit message.

• PR_TITLE - default to the pull request’s title.
• PR_BODY - default to the pull request’s body.
• BLANK - default to a blank commit message.

string

Allowed values: PR_BODY PR_TITLE BLANK

allow_merge_commit

Whether to allow merge commits for pull requests.

boolean

default: true

allow_forking

Whether to allow forking this repo

boolean

web_commit_signoff_required

Whether to require contributors to sign off on web-based commits

boolean

open_issues

required

integer

watchers

required

integer

master_branch

string

starred_at

string

anonymous_access_enabled

Whether anonymous git access is enabled for this repository

boolean

code_search_index_status

The status of the code search index for this repository

object

lexical_search_ok

boolean

lexical_commit_sha

string

performed_via_github_app

GitHub app

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

object

id

required

Unique identifier of the GitHub app

integer

slug

The slug name of the GitHub app

string

node_id

required

string

client_id

string

owner

required

One of:

Simple User

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

Enterprise

Enterprise

An enterprise on GitHub.

object

description

A short description of the enterprise.

string

nullable

html_url

required

string format: uri

website_url

The enterprise’s website URL.

string format: uri

nullable

id

required

Unique identifier of the enterprise

integer

node_id

required

string

name

required

The name of the enterprise.

string

slug

required

The slug url identifier for the enterprise.

string

created_at

required

string format: date-time

nullable

updated_at

required

string format: date-time

nullable

avatar_url

required

string format: uri

name

required

The name of the GitHub app

string

description

required

string

nullable

external_url

required

string format: uri

html_url

required

string format: uri

created_at

required

string format: date-time

updated_at

required

string format: date-time

permissions

required

The set of permissions for the GitHub app

object

issues

string

checks

string

metadata

string

contents

string

deployments

string

key

additional properties

string

events

required

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

Array<string>

installations_count

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

integer

author_association

author_association

How the author is associated with the repository.

string

Allowed values: COLLABORATOR CONTRIBUTOR FIRST_TIMER FIRST_TIME_CONTRIBUTOR MANNEQUIN MEMBER NONE OWNER

reactions

Reaction Rollup

object

url

required

string format: uri

total_count

required

integer

+1

required

integer

-1

required

integer

laugh

required

integer

confused

required

integer

heart

required

integer

hooray

required

integer

eyes

required

integer

rocket

required

integer

sub_issues_summary

Sub-issues Summary

object

total

required

integer

completed

required

integer

percent_completed

required

integer

parent_issue_url

URL to get the parent issue of this issue, if it is a sub-issue

string format: uri

nullable

pinned_comment

Issue Comment

Comments provide a way for people to collaborate on an issue.

object

id

required

Unique identifier of the issue comment

integer format: int64

node_id

required

string

url

required

URL for the issue comment

string format: uri

body

Contents of the issue comment

string

body_text

string

body_html

string

html_url

required

string format: uri

user

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

created_at

required

string format: date-time

updated_at

required

string format: date-time

issue_url

required

string format: uri

author_association

author_association

How the author is associated with the repository.

string

Allowed values: COLLABORATOR CONTRIBUTOR FIRST_TIMER FIRST_TIME_CONTRIBUTOR MANNEQUIN MEMBER NONE OWNER

performed_via_github_app

GitHub app

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

object

id

required

Unique identifier of the GitHub app

integer

slug

The slug name of the GitHub app

string

node_id

required

string

client_id

string

owner

required

One of:

Simple User

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

Enterprise

Enterprise

An enterprise on GitHub.

object

description

A short description of the enterprise.

string

nullable

html_url

required

string format: uri

website_url

The enterprise’s website URL.

string format: uri

nullable

id

required

Unique identifier of the enterprise

integer

node_id

required

string

name

required

The name of the enterprise.

string

slug

required

The slug url identifier for the enterprise.

string

created_at

required

string format: date-time

nullable

updated_at

required

string format: date-time

nullable

avatar_url

required

string format: uri

name

required

The name of the GitHub app

string

description

required

string

nullable

external_url

required

string format: uri

html_url

required

string format: uri

created_at

required

string format: date-time

updated_at

required

string format: date-time

permissions

required

The set of permissions for the GitHub app

object

issues

string

checks

string

metadata

string

contents

string

deployments

string

key

additional properties

string

events

required

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

Array<string>

installations_count

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

integer

reactions

Reaction Rollup

object

url

required

string format: uri

total_count

required

integer

+1

required

integer

-1

required

integer

laugh

required

integer

confused

required

integer

heart

required

integer

hooray

required

integer

eyes

required

integer

rocket

required

integer

pin

Pinned Issue Comment

Context around who pinned an issue comment and when it was pinned.

object

pinned_at

required

string format: date-time

pinned_by

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

minimized

Minimized Issue Comment

Details about why an issue comment was minimized.

object

reason

required

The reason the comment was minimized.

string

nullable

issue_dependencies_summary

Issue Dependencies Summary

object

blocked_by

required

integer

blocking

required

integer

total_blocked_by

required

integer

total_blocking

required

integer

issue_field_values

Array<object>

Issue Field Value

A value assigned to an issue field

object

issue_field_id

required

Unique identifier for the issue field.

integer format: int64

issue_field_name

The human-readable name of the issue field.

string

node_id

required

string

data_type

required

The data type of the issue field

string

Allowed values: text single_select multi_select number date

value

required

Any of:

string

string

number

number

integer

integer

single_select_option

Details about the selected option (only present for single_select fields)

object

id

required

Unique identifier for the option.

integer format: int64

name

required

The name of the option

string

color

required

The color of the option

string

multi_select_options

Details about the selected options

Array<object>

nullable

object

id

required

Unique identifier for the option.

integer format: int64

name

required

The name of the option

string

color

required

The color of the option

string

label

Issue Event Label

Issue Event Label

object

name

required

string

nullable

color

required

string

nullable

assignee

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

assigner

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

review_requester

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

requested_reviewer

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

requested_team

Team

Groups of organization members that gives permissions on specified repositories.

object

id

required

integer

node_id

required

string

name

required

string

slug

required

string

description

required

string

nullable

privacy

string

notification_setting

string

permission

required

string

permissions

object

pull

required

boolean

triage

required

boolean

push

required

boolean

maintain

required

boolean

admin

required

boolean

url

required

string format: uri

html_url

required

string format: uri

members_url

required

string

repositories_url

required

string format: uri

type

required

The ownership type of the team

string

Allowed values: enterprise organization

access_source

How the team’s access to the repository was granted. This property is only present when the team is returned in a repository context, such as GET /repos/{owner}/{repo}/teams.

string

Allowed values: direct organization enterprise

organization_id

Unique identifier of the organization to which this team belongs

integer

enterprise_id

Unique identifier of the enterprise to which this team belongs

integer

parent

required

Team Simple

Groups of organization members that gives permissions on specified repositories.

object

id

required

Unique identifier of the team

integer

node_id

required

string

url

required

URL for the team

string format: uri

members_url

required

string

name

required

Name of the team

string

description

required

Description of the team

string

nullable

permission

required

Permission that the team will have for its repositories

string

privacy

The level of privacy this team should have

string

notification_setting

The notification setting the team has set

string

html_url

required

string format: uri

repositories_url

required

string format: uri

slug

required

string

ldap_dn

Distinguished Name (DN) that team maps to within LDAP environment

string

type

required

The ownership type of the team

string

Allowed values: enterprise organization

organization_id

Unique identifier of the organization to which this team belongs

integer

enterprise_id

Unique identifier of the enterprise to which this team belongs

integer

dismissed_review

Issue Event Dismissed Review

object

state

required

string

review_id

required

integer

dismissal_message

required

string

nullable

dismissal_commit_id

string

nullable

milestone

Issue Event Milestone

Issue Event Milestone

object

title

required

string

project_card

Issue Event Project Card

Issue Event Project Card

object

url

required

string format: uri

id

required

integer

project_url

required

string format: uri

project_id

required

integer

column_name

required

string

previous_column_name

string

rename

Issue Event Rename

Issue Event Rename

object

from

required

string

to

required

string

issue_type

Issue Type

The type of issue.

object

id

required

The unique identifier of the issue type.

integer

name

required

The name of the issue type.

string

color

The color of the issue type.

string

nullable

Allowed values: gray blue green yellow orange red pink purple

prev_issue_type

Issue Type

The type of issue.

object

id

required

The unique identifier of the issue type.

integer

name

required

The name of the issue type.

string

color

The color of the issue type.

string

nullable

Allowed values: gray blue green yellow orange red pink purple

sub_issue

Issue Reference

A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events).

object

number

required

The number of the referenced issue.

integer

title

required

The title of the referenced issue.

string

state

required

The state of the referenced issue.

string

state_reason

The reason for the referenced issue’s state.

string

nullable

repository

required

Simple Repository

A GitHub repository.

object

id

required

A unique identifier of the repository.

integer format: int64

node_id

required

The GraphQL identifier of the repository.

string

name

required

The name of the repository.

string

full_name

required

The full, globally unique, name of the repository.

string

owner

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

private

required

Whether the repository is private.

boolean

html_url

required

The URL to view the repository on GitHub.com.

string format: uri

description

required

The repository description.

string

nullable

fork

required

Whether the repository is a fork.

boolean

url

required

The URL to get more information about the repository from the GitHub API.

string format: uri

archive_url

required

A template for the API URL to download the repository as an archive.

string

assignees_url

required

A template for the API URL to list the available assignees for issues in the repository.

string

blobs_url

required

A template for the API URL to create or retrieve a raw Git blob in the repository.

string

branches_url

required

A template for the API URL to get information about branches in the repository.

string

collaborators_url

required

A template for the API URL to get information about collaborators of the repository.

string

comments_url

required

A template for the API URL to get information about comments on the repository.

string

commits_url

required

A template for the API URL to get information about commits on the repository.

string

compare_url

required

A template for the API URL to compare two commits or refs.

string

contents_url

required

A template for the API URL to get the contents of the repository.

string

contributors_url

required

A template for the API URL to list the contributors to the repository.

string format: uri

deployments_url

required

The API URL to list the deployments of the repository.

string format: uri

downloads_url

required

The API URL to list the downloads on the repository.

string format: uri

events_url

required

The API URL to list the events of the repository.

string format: uri

forks_url

required

The API URL to list the forks of the repository.

string format: uri

git_commits_url

required

A template for the API URL to get information about Git commits of the repository.

string

git_refs_url

required

A template for the API URL to get information about Git refs of the repository.

string

git_tags_url

required

A template for the API URL to get information about Git tags of the repository.

string

issue_comment_url

required

A template for the API URL to get information about issue comments on the repository.

string

issue_events_url

required

A template for the API URL to get information about issue events on the repository.

string

issues_url

required

A template for the API URL to get information about issues on the repository.

string

keys_url

required

A template for the API URL to get information about deploy keys on the repository.

string

labels_url

required

A template for the API URL to get information about labels of the repository.

string

languages_url

required

The API URL to get information about the languages of the repository.

string format: uri

merges_url

required

The API URL to merge branches in the repository.

string format: uri

milestones_url

required

A template for the API URL to get information about milestones of the repository.

string

notifications_url

required

A template for the API URL to get information about notifications on the repository.

string

pulls_url

required

A template for the API URL to get information about pull requests on the repository.

string

releases_url

required

A template for the API URL to get information about releases on the repository.

string

stargazers_url

required

The API URL to list the stargazers on the repository.

string format: uri

statuses_url

required

A template for the API URL to get information about statuses of a commit.

string

subscribers_url

required

The API URL to list the subscribers on the repository.

string format: uri

subscription_url

required

The API URL to subscribe to notifications for this repository.

string format: uri

tags_url

required

The API URL to get information about tags on the repository.

string format: uri

teams_url

required

The API URL to list the teams on the repository.

string format: uri

trees_url

required

A template for the API URL to create or retrieve a raw Git tree of the repository.

string

hooks_url

required

The API URL to list the hooks on the repository.

string format: uri

issue_type

required

Issue Type

The type of the referenced issue.

object

id

required

The unique identifier of the issue type.

integer

node_id

required

The node identifier of the issue type.

string

name

required

The name of the issue type.

string

color

The color of the issue type.

string

nullable

parent_issue

Issue Reference

A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events).

object

number

required

The number of the referenced issue.

integer

title

required

The title of the referenced issue.

string

state

required

The state of the referenced issue.

string

state_reason

The reason for the referenced issue’s state.

string

nullable

repository

required

Simple Repository

A GitHub repository.

object

id

required

A unique identifier of the repository.

integer format: int64

node_id

required

The GraphQL identifier of the repository.

string

name

required

The name of the repository.

string

full_name

required

The full, globally unique, name of the repository.

string

owner

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

private

required

Whether the repository is private.

boolean

html_url

required

The URL to view the repository on GitHub.com.

string format: uri

description

required

The repository description.

string

nullable

fork

required

Whether the repository is a fork.

boolean

url

required

The URL to get more information about the repository from the GitHub API.

string format: uri

archive_url

required

A template for the API URL to download the repository as an archive.

string

assignees_url

required

A template for the API URL to list the available assignees for issues in the repository.

string

blobs_url

required

A template for the API URL to create or retrieve a raw Git blob in the repository.

string

branches_url

required

A template for the API URL to get information about branches in the repository.

string

collaborators_url

required

A template for the API URL to get information about collaborators of the repository.

string

comments_url

required

A template for the API URL to get information about comments on the repository.

string

commits_url

required

A template for the API URL to get information about commits on the repository.

string

compare_url

required

A template for the API URL to compare two commits or refs.

string

contents_url

required

A template for the API URL to get the contents of the repository.

string

contributors_url

required

A template for the API URL to list the contributors to the repository.

string format: uri

deployments_url

required

The API URL to list the deployments of the repository.

string format: uri

downloads_url

required

The API URL to list the downloads on the repository.

string format: uri

events_url

required

The API URL to list the events of the repository.

string format: uri

forks_url

required

The API URL to list the forks of the repository.

string format: uri

git_commits_url

required

A template for the API URL to get information about Git commits of the repository.

string

git_refs_url

required

A template for the API URL to get information about Git refs of the repository.

string

git_tags_url

required

A template for the API URL to get information about Git tags of the repository.

string

issue_comment_url

required

A template for the API URL to get information about issue comments on the repository.

string

issue_events_url

required

A template for the API URL to get information about issue events on the repository.

string

issues_url

required

A template for the API URL to get information about issues on the repository.

string

keys_url

required

A template for the API URL to get information about deploy keys on the repository.

string

labels_url

required

A template for the API URL to get information about labels of the repository.

string

languages_url

required

The API URL to get information about the languages of the repository.

string format: uri

merges_url

required

The API URL to merge branches in the repository.

string format: uri

milestones_url

required

A template for the API URL to get information about milestones of the repository.

string

notifications_url

required

A template for the API URL to get information about notifications on the repository.

string

pulls_url

required

A template for the API URL to get information about pull requests on the repository.

string

releases_url

required

A template for the API URL to get information about releases on the repository.

string

stargazers_url

required

The API URL to list the stargazers on the repository.

string format: uri

statuses_url

required

A template for the API URL to get information about statuses of a commit.

string

subscribers_url

required

The API URL to list the subscribers on the repository.

string format: uri

subscription_url

required

The API URL to subscribe to notifications for this repository.

string format: uri

tags_url

required

The API URL to get information about tags on the repository.

string format: uri

teams_url

required

The API URL to list the teams on the repository.

string format: uri

trees_url

required

A template for the API URL to create or retrieve a raw Git tree of the repository.

string

hooks_url

required

The API URL to list the hooks on the repository.

string format: uri

issue_type

required

Issue Type

The type of the referenced issue.

object

id

required

The unique identifier of the issue type.

integer

node_id

required

The node identifier of the issue type.

string

name

required

The name of the issue type.

string

color

The color of the issue type.

string

nullable

blocked_by

Issue Reference

A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events).

object

number

required

The number of the referenced issue.

integer

title

required

The title of the referenced issue.

string

state

required

The state of the referenced issue.

string

state_reason

The reason for the referenced issue’s state.

string

nullable

repository

required

Simple Repository

A GitHub repository.

object

id

required

A unique identifier of the repository.

integer format: int64

node_id

required

The GraphQL identifier of the repository.

string

name

required

The name of the repository.

string

full_name

required

The full, globally unique, name of the repository.

string

owner

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

private

required

Whether the repository is private.

boolean

html_url

required

The URL to view the repository on GitHub.com.

string format: uri

description

required

The repository description.

string

nullable

fork

required

Whether the repository is a fork.

boolean

url

required

The URL to get more information about the repository from the GitHub API.

string format: uri

archive_url

required

A template for the API URL to download the repository as an archive.

string

assignees_url

required

A template for the API URL to list the available assignees for issues in the repository.

string

blobs_url

required

A template for the API URL to create or retrieve a raw Git blob in the repository.

string

branches_url

required

A template for the API URL to get information about branches in the repository.

string

collaborators_url

required

A template for the API URL to get information about collaborators of the repository.

string

comments_url

required

A template for the API URL to get information about comments on the repository.

string

commits_url

required

A template for the API URL to get information about commits on the repository.

string

compare_url

required

A template for the API URL to compare two commits or refs.

string

contents_url

required

A template for the API URL to get the contents of the repository.

string

contributors_url

required

A template for the API URL to list the contributors to the repository.

string format: uri

deployments_url

required

The API URL to list the deployments of the repository.

string format: uri

downloads_url

required

The API URL to list the downloads on the repository.

string format: uri

events_url

required

The API URL to list the events of the repository.

string format: uri

forks_url

required

The API URL to list the forks of the repository.

string format: uri

git_commits_url

required

A template for the API URL to get information about Git commits of the repository.

string

git_refs_url

required

A template for the API URL to get information about Git refs of the repository.

string

git_tags_url

required

A template for the API URL to get information about Git tags of the repository.

string

issue_comment_url

required

A template for the API URL to get information about issue comments on the repository.

string

issue_events_url

required

A template for the API URL to get information about issue events on the repository.

string

issues_url

required

A template for the API URL to get information about issues on the repository.

string

keys_url

required

A template for the API URL to get information about deploy keys on the repository.

string

labels_url

required

A template for the API URL to get information about labels of the repository.

string

languages_url

required

The API URL to get information about the languages of the repository.

string format: uri

merges_url

required

The API URL to merge branches in the repository.

string format: uri

milestones_url

required

A template for the API URL to get information about milestones of the repository.

string

notifications_url

required

A template for the API URL to get information about notifications on the repository.

string

pulls_url

required

A template for the API URL to get information about pull requests on the repository.

string

releases_url

required

A template for the API URL to get information about releases on the repository.

string

stargazers_url

required

The API URL to list the stargazers on the repository.

string format: uri

statuses_url

required

A template for the API URL to get information about statuses of a commit.

string

subscribers_url

required

The API URL to list the subscribers on the repository.

string format: uri

subscription_url

required

The API URL to subscribe to notifications for this repository.

string format: uri

tags_url

required

The API URL to get information about tags on the repository.

string format: uri

teams_url

required

The API URL to list the teams on the repository.

string format: uri

trees_url

required

A template for the API URL to create or retrieve a raw Git tree of the repository.

string

hooks_url

required

The API URL to list the hooks on the repository.

string format: uri

issue_type

required

Issue Type

The type of the referenced issue.

object

id

required

The unique identifier of the issue type.

integer

node_id

required

The node identifier of the issue type.

string

name

required

The name of the issue type.

string

color

The color of the issue type.

string

nullable

blocking

Issue Reference

A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events).

object

number

required

The number of the referenced issue.

integer

title

required

The title of the referenced issue.

string

state

required

The state of the referenced issue.

string

state_reason

The reason for the referenced issue’s state.

string

nullable

repository

required

Simple Repository

A GitHub repository.

object

id

required

A unique identifier of the repository.

integer format: int64

node_id

required

The GraphQL identifier of the repository.

string

name

required

The name of the repository.

string

full_name

required

The full, globally unique, name of the repository.

string

owner

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

private

required

Whether the repository is private.

boolean

html_url

required

The URL to view the repository on GitHub.com.

string format: uri

description

required

The repository description.

string

nullable

fork

required

Whether the repository is a fork.

boolean

url

required

The URL to get more information about the repository from the GitHub API.

string format: uri

archive_url

required

A template for the API URL to download the repository as an archive.

string

assignees_url

required

A template for the API URL to list the available assignees for issues in the repository.

string

blobs_url

required

A template for the API URL to create or retrieve a raw Git blob in the repository.

string

branches_url

required

A template for the API URL to get information about branches in the repository.

string

collaborators_url

required

A template for the API URL to get information about collaborators of the repository.

string

comments_url

required

A template for the API URL to get information about comments on the repository.

string

commits_url

required

A template for the API URL to get information about commits on the repository.

string

compare_url

required

A template for the API URL to compare two commits or refs.

string

contents_url

required

A template for the API URL to get the contents of the repository.

string

contributors_url

required

A template for the API URL to list the contributors to the repository.

string format: uri

deployments_url

required

The API URL to list the deployments of the repository.

string format: uri

downloads_url

required

The API URL to list the downloads on the repository.

string format: uri

events_url

required

The API URL to list the events of the repository.

string format: uri

forks_url

required

The API URL to list the forks of the repository.

string format: uri

git_commits_url

required

A template for the API URL to get information about Git commits of the repository.

string

git_refs_url

required

A template for the API URL to get information about Git refs of the repository.

string

git_tags_url

required

A template for the API URL to get information about Git tags of the repository.

string

issue_comment_url

required

A template for the API URL to get information about issue comments on the repository.

string

issue_events_url

required

A template for the API URL to get information about issue events on the repository.

string

issues_url

required

A template for the API URL to get information about issues on the repository.

string

keys_url

required

A template for the API URL to get information about deploy keys on the repository.

string

labels_url

required

A template for the API URL to get information about labels of the repository.

string

languages_url

required

The API URL to get information about the languages of the repository.

string format: uri

merges_url

required

The API URL to merge branches in the repository.

string format: uri

milestones_url

required

A template for the API URL to get information about milestones of the repository.

string

notifications_url

required

A template for the API URL to get information about notifications on the repository.

string

pulls_url

required

A template for the API URL to get information about pull requests on the repository.

string

releases_url

required

A template for the API URL to get information about releases on the repository.

string

stargazers_url

required

The API URL to list the stargazers on the repository.

string format: uri

statuses_url

required

A template for the API URL to get information about statuses of a commit.

string

subscribers_url

required

The API URL to list the subscribers on the repository.

string format: uri

subscription_url

required

The API URL to subscribe to notifications for this repository.

string format: uri

tags_url

required

The API URL to get information about tags on the repository.

string format: uri

teams_url

required

The API URL to list the teams on the repository.

string format: uri

trees_url

required

A template for the API URL to create or retrieve a raw Git tree of the repository.

string

hooks_url

required

The API URL to list the hooks on the repository.

string format: uri

issue_type

required

Issue Type

The type of the referenced issue.

object

id

required

The unique identifier of the issue type.

integer

node_id

required

The node identifier of the issue type.

string

name

required

The name of the issue type.

string

color

The color of the issue type.

string

nullable

author_association

author_association

How the author is associated with the repository.

string

Allowed values: COLLABORATOR CONTRIBUTOR FIRST_TIMER FIRST_TIME_CONTRIBUTOR MANNEQUIN MEMBER NONE OWNER

lock_reason

string

nullable

performed_via_github_app

GitHub app

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

object

id

required

Unique identifier of the GitHub app

integer

slug

The slug name of the GitHub app

string

node_id

required

string

client_id

string

owner

required

One of:

Simple User

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

Enterprise

Enterprise

An enterprise on GitHub.

object

description

A short description of the enterprise.

string

nullable

html_url

required

string format: uri

website_url

The enterprise’s website URL.

string format: uri

nullable

id

required

Unique identifier of the enterprise

integer

node_id

required

string

name

required

The name of the enterprise.

string

slug

required

The slug url identifier for the enterprise.

string

created_at

required

string format: date-time

nullable

updated_at

required

string format: date-time

nullable

avatar_url

required

string format: uri

name

required

The name of the GitHub app

string

description

required

string

nullable

external_url

required

string format: uri

html_url

required

string format: uri

created_at

required

string format: date-time

updated_at

required

string format: date-time

permissions

required

The set of permissions for the GitHub app

object

issues

string

checks

string

metadata

string

contents

string

deployments

string

key

additional properties

string

events

required

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

Array<string>

installations_count

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

integer

Examples

Example default

[
  {
    "id": 1,
    "node_id": "MDEwOklzc3VlRXZlbnQx",
    "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1",
    "actor": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "event": "closed",
    "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
    "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
    "created_at": "2011-04-14T16:00:49Z",
    "issue": {
      "id": 1,
      "node_id": "MDU6SXNzdWUx",
      "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
      "repository_url": "https://api.github.com/repos/octocat/Hello-World",
      "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",
      "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",
      "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",
      "html_url": "https://github.com/octocat/Hello-World/issues/1347",
      "number": 1347,
      "state": "open",
      "title": "Found a bug",
      "body": "I'm having a problem with this.",
      "user": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "pinned_comment": null,
      "labels": [
        {
          "id": 208045946,
          "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
          "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
          "name": "bug",
          "description": "Something isn't working",
          "color": "f29513",
          "default": true
        }
      ],
      "assignee": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "assignees": [
        {
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "",
          "url": "https://api.github.com/users/octocat",
          "html_url": "https://github.com/octocat",
          "followers_url": "https://api.github.com/users/octocat/followers",
          "following_url": "https://api.github.com/users/octocat/following{/other_user}",
          "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
          "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
          "organizations_url": "https://api.github.com/users/octocat/orgs",
          "repos_url": "https://api.github.com/users/octocat/repos",
          "events_url": "https://api.github.com/users/octocat/events{/privacy}",
          "received_events_url": "https://api.github.com/users/octocat/received_events",
          "type": "User",
          "site_admin": false
        }
      ],
      "milestone": {
        "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
        "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
        "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
        "id": 1002604,
        "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
        "number": 1,
        "state": "open",
        "title": "v1.0",
        "description": "Tracking milestone for version 1.0",
        "creator": {
          "login": "octocat",
          "id": 1,
          "node_id": "MDQ6VXNlcjE=",
          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
          "gravatar_id": "",
          "url": "https://api.github.com/users/octocat",
          "html_url": "https://github.com/octocat",
          "followers_url": "https://api.github.com/users/octocat/followers",
          "following_url": "https://api.github.com/users/octocat/following{/other_user}",
          "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
          "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
          "organizations_url": "https://api.github.com/users/octocat/orgs",
          "repos_url": "https://api.github.com/users/octocat/repos",
          "events_url": "https://api.github.com/users/octocat/events{/privacy}",
          "received_events_url": "https://api.github.com/users/octocat/received_events",
          "type": "User",
          "site_admin": false
        },
        "open_issues": 4,
        "closed_issues": 8,
        "created_at": "2011-04-10T20:09:31Z",
        "updated_at": "2014-03-03T18:58:10Z",
        "closed_at": "2013-02-12T13:22:01Z",
        "due_on": "2012-10-09T23:39:01Z"
      },
      "locked": true,
      "active_lock_reason": "too heated",
      "comments": 0,
      "pull_request": {
        "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",
        "html_url": "https://github.com/octocat/Hello-World/pull/1347",
        "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
        "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
      },
      "closed_at": null,
      "created_at": "2011-04-22T13:33:48Z",
      "updated_at": "2011-04-22T13:33:48Z",
      "author_association": "COLLABORATOR",
      "state_reason": "completed"
    }
  }
]

Headers

Link

string

Example

<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"

422

Validation failed, or the endpoint has been spammed.

Media type application/json

Validation Error

Validation Error

object

message

required

string

documentation_url

required

string

errors

Array<object>

object

resource

string

field

string

message

string

code

required

string

index

integer

value

One of:

string

string

nullable

integer

integer

nullable

Array<string>

Array<string>

nullable

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}