Get an issue event

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

Copy endpoint

https://api.github.com

Gets a single event by the event id.

Parameters

path Path Parameters

Name	Type
`owner` required The account owner of the repository. The name is not case sensitive.	string
`repo` required The name of the repository without the `.git` extension. The name is not case sensitive.	string
`event_id` required	number

Responses

200 application/json

Response

interface IssueEvent {
id: number;
node_id: string;
url: string;
actor:

SimpleUser

A GitHub user.

interface SimpleUser {
name?: string | null;
email?: string | null;
login: string;
id: number;
node_id: string;
avatar_url: string;
gravatar_id: string | null;
url: string;
html_url: string;
followers_url: string;
following_url: string;
gists_url: string;
starred_url: string;
subscriptions_url: string;
organizations_url: string;
repos_url: string;
events_url: string;
received_events_url: string;
type: string;
site_admin: boolean;
starred_at?: string;
user_view_type?: string;
}

| null;
event: string;
commit_id: string | null;
commit_url: string | null;
created_at: string;
issue?:

Issue

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

interface Issue {
id: number;
node_id: string;
url: string;
repository_url: string;
labels_url: string;
comments_url: string;
events_url: string;
html_url: string;
number: number;
state: string;
state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null;
title: string;
body?: string | null;
user: SimpleUser | null;
labels: ({
id?: number;
node_id?: string;
url?: string;
name?: string;
description?: string | null;
color?: string | null;
default?: boolean;
} | string)[];
assignee: SimpleUser | null;
assignees?: SimpleUser[] | null;
milestone: Milestone | null;
locked: boolean;
active_lock_reason?: string | null;
comments: number;
pull_request?: {
merged_at?: string | null;
diff_url: string | null;
html_url: string | null;
patch_url: string | null;
url: string | null;
};
closed_at: string | null;
created_at: string;
updated_at: string;
draft?: boolean;
closed_by?: SimpleUser | null;
body_html?: string;
body_text?: string;
timeline_url?: string;
type?: IssueType;
repository?: Repository;
performed_via_github_app?: Integration | null;
author_association?: AuthorAssociation;
reactions?: ReactionRollup;
sub_issues_summary?: SubIssuesSummary;
parent_issue_url?: string | null;
issue_dependencies_summary?: IssueDependenciesSummary;
issue_field_values?: IssueFieldValue[];
}

| null;
label?:

IssueEventLabel

Issue Event Label

interface IssueEventLabel {
name: string | null;
color: string | null;
}

;
assignee?:

SimpleUser

A GitHub user.

| null;
assigner?:

SimpleUser

A GitHub user.

| null;
review_requester?:

SimpleUser

A GitHub user.

| null;
requested_reviewer?:

SimpleUser

A GitHub user.

| null;
requested_team?:

Team

Groups of organization members that gives permissions on specified repositories.

interface Team {
id: number;
node_id: string;
name: string;
slug: string;
description: string | null;
privacy?: string;
notification_setting?: string;
permission: string;
permissions?: {
pull: boolean;
triage: boolean;
push: boolean;
maintain: boolean;
admin: boolean;
};
url: string;
html_url: string;
members_url: string;
repositories_url: string;
type: "enterprise" | "organization";
organization_id?: number;
enterprise_id?: number;
parent: TeamSimple | null;
}

;
dismissed_review?:

IssueEventDismissedReview

interface IssueEventDismissedReview {
state: string;
review_id: number;
dismissal_message: string | null;
dismissal_commit_id?: string | null;
}

;
milestone?:

IssueEventMilestone

Issue Event Milestone

interface IssueEventMilestone {
title: string;
}

;
project_card?:

IssueEventProjectCard

Issue Event Project Card

interface IssueEventProjectCard {
url: string;
id: number;
project_url: string;
project_id: number;
column_name: string;
previous_column_name?: string;
}

;
rename?:

IssueEventRename

Issue Event Rename

interface IssueEventRename {
from: string;
to: string;
}

;
author_association?:

AuthorAssociation

How the author is associated with the repository.

;
lock_reason?: string | null;
performed_via_github_app?:

Integration

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.

type Integration = {
id: number;
slug?: string;
node_id: string;
client_id?: string;
owner: SimpleUser | Enterprise;
name: string;
description: string | null;
external_url: string;
html_url: string;
created_at: string;
updated_at: string;
permissions: {
issues?: string;
checks?: string;
metadata?: string;
contents?: string;
deployments?: string;
[key: string]: string;
};
events: string[];
installations_count?: number;
} | null

| null;
}

Client Errors

403 application/json

Forbidden

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}

404 application/json

Resource not found

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}

410 application/json

Gone

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}