Skip to content

GitHub: Activity schemas

28 GitHub schemas with complete fields and constraints.

← Activity operations · All schemas

Get a repository subscription — response body

FieldTypePresenceDescription and constraints
$objectRootRepository invitations let you manage who you collaborate with.
created_atstringRequired within parentFormat: date-time
ignoredbooleanRequired within parentDetermines if all notifications should be blocked from this repository.
reasonJSONRequired within parent
reason (anyOf 1)stringAlternative
reason (anyOf 2)nullAlternative
repository_urlstringRequired within parentFormat: uri
subscribedbooleanRequired within parentDetermines if notifications should be received from this repository.
urlstringRequired within parentFormat: uri

Get a thread — response body

FieldTypePresenceDescription and constraints
$objectRootThread
idstringRequired within parent
last_read_atJSONRequired within parent
last_read_at (anyOf 1)stringAlternative
last_read_at (anyOf 2)nullAlternative
reasonstringRequired within parent
repositoryModelRequired within parentExpand Transfer a repository — response body
subjectobjectRequired within parent
subject.latest_comment_urlstringRequired within parent
subject.titlestringRequired within parent
subject.typestringRequired within parent
subject.urlstringRequired within parent
subscription_urlstringRequired within parent
unreadbooleanRequired within parent
updated_atstringRequired within parent
urlstringRequired within parent

Referenced models: Transfer a repository — response body

Get feeds — response body

FieldTypePresenceDescription and constraints
$objectRootFeed
_linksobjectRequired within parent
_links.current_userModelOptionalExpand Get feeds — response body — links user
_links.current_user_actorModelOptionalExpand Get feeds — response body — links user
_links.current_user_organizationModelOptionalExpand Get feeds — response body — links user
_links.current_user_organizationsarrayOptional
_links.current_user_organizations[]ModelEach itemExpand Get feeds — response body — links user
_links.current_user_publicModelOptionalExpand Get feeds — response body — links user
_links.repository_discussionsModelOptionalExpand Get feeds — response body — links user
_links.repository_discussions_categoryModelOptionalExpand Get feeds — response body — links user
_links.security_advisoriesModelOptionalExpand Get feeds — response body — links user
_links.timelineModelRequired within parentExpand Get feeds — response body — links user
_links.userModelRequired within parentExpand Get feeds — response body — links user
current_user_actor_urlstringOptional
current_user_organization_urlstringOptional
current_user_organization_urlsarrayOptional
current_user_organization_urls[]stringEach itemFormat: uri
current_user_public_urlstringOptional
current_user_urlstringOptional
repository_discussions_category_urlstringOptionalA feed of discussions for a given repository and category.
repository_discussions_urlstringOptionalA feed of discussions for a given repository.
security_advisories_urlstringOptional
timeline_urlstringRequired within parent
user_urlstringRequired within parent

Referenced models: Get feeds — response body — links user

Get feeds — response body — links user

FieldTypePresenceDescription and constraints
$objectRootHypermedia Link with Type
hrefstringRequired within parent
typestringRequired within parent

Get repository star history — response body — item

FieldTypePresenceDescription and constraints
$objectRootStargazer History
daysarrayRequired within parentThe number of stars created on each day of the week, starting on Sunday.
days[]JSONEach item
days[] (anyOf 1)integerAlternative
days[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalJSONRequired within parent
total (anyOf 1)integerAlternativeThe number of stars created during the week.
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
weekJSONRequired within parent
week (anyOf 1)integerAlternativeThe start of the week, given as a Unix timestamp.
week (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List public events — response body — item

FieldTypePresenceDescription and constraints
$objectRootEvent
actorModelRequired within parentExpand List public events — response body — item org
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeFormat: date-time
created_at (anyOf 2)nullAlternative
idstringRequired within parent
orgModelOptionalExpand List public events — response body — item org
payloadJSONRequired within parent
payload (anyOf 1)ModelAlternativeExpand List public events — response body — item payload Create Event
payload (anyOf 2)ModelAlternativeExpand List public events — response body — item payload Delete Event
payload (anyOf 3)ModelAlternativeExpand List public events — response body — item payload Discussion Event
payload (anyOf 4)ModelAlternativeExpand List public events — response body — item payload Issues Event
payload (anyOf 5)ModelAlternativeExpand List public events — response body — item payload Issue Comment Event
payload (anyOf 6)ModelAlternativeExpand List public events — response body — item payload Fork Event
payload (anyOf 7)ModelAlternativeExpand List public events — response body — item payload Gollum Event
payload (anyOf 8)ModelAlternativeExpand List public events — response body — item payload Member Event
payload (anyOf 9)ModelAlternativeExpand List public events — response body — item payload Public Event
payload (anyOf 10)ModelAlternativeExpand List public events — response body — item payload Push Event
payload (anyOf 11)ModelAlternativeExpand List public events — response body — item payload Pull Request Event
payload (anyOf 12)ModelAlternativeExpand List public events — response body — item payload Pull Request Review Comment Event
payload (anyOf 13)ModelAlternativeExpand List public events — response body — item payload Pull Request Review Event
payload (anyOf 14)ModelAlternativeExpand List public events — response body — item payload Commit Comment Event
payload (anyOf 15)ModelAlternativeExpand List public events — response body — item payload Release Event
payload (anyOf 16)ModelAlternativeExpand List public events — response body — item payload Watch Event
publicbooleanRequired within parent
repoobjectRequired within parent
repo.idJSONRequired within parent
repo.id (anyOf 1)integerAlternative
repo.id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
repo.namestringRequired within parent
repo.urlstringRequired within parentFormat: uri
typeJSONRequired within parent
type (anyOf 1)stringAlternative
type (anyOf 2)nullAlternative

Referenced models: List public events — response body — item org, List public events — response body — item payload Commit Comment Event, List public events — response body — item payload Create Event, List public events — response body — item payload Delete Event, List public events — response body — item payload Discussion Event, List public events — response body — item payload Fork Event, List public events — response body — item payload Gollum Event, List public events — response body — item payload Issue Comment Event, List public events — response body — item payload Issues Event, List public events — response body — item payload Member Event, List public events — response body — item payload Public Event, List public events — response body — item payload Pull Request Event, List public events — response body — item payload Pull Request Review Comment Event, List public events — response body — item payload Pull Request Review Event, List public events — response body — item payload Push Event, List public events — response body — item payload Release Event, List public events — response body — item payload Watch Event

List public events — response body — item org

FieldTypePresenceDescription and constraints
$objectRootActor
avatar_urlstringRequired within parentFormat: uri
display_loginstringOptional
gravatar_idJSONRequired within parent
gravatar_id (anyOf 1)stringAlternative
gravatar_id (anyOf 2)nullAlternative
idJSONRequired within parent
id (anyOf 1)integerAlternative
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
loginstringRequired within parent
urlstringRequired within parentFormat: uri

List public events — response body — item payload Commit Comment Event

FieldTypePresenceDescription and constraints
$objectRoot
actionstringRequired within parent
commentobjectRequired within parent
comment.bodystringOptional
comment.commit_idstringOptional
comment.created_atstringOptionalFormat: date-time
comment.html_urlstringOptionalFormat: uri
comment.idJSONOptional
comment.id (anyOf 1)integerAlternative
comment.id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.lineJSONOptional
comment.line (anyOf 1)JSONAlternative
comment.line (anyOf 1) (anyOf 1)integerAlternative
comment.line (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.line (anyOf 2)nullAlternative
comment.node_idstringOptional
comment.pathJSONOptional
comment.path (anyOf 1)stringAlternative
comment.path (anyOf 2)nullAlternative
comment.positionJSONOptional
comment.position (anyOf 1)JSONAlternative
comment.position (anyOf 1) (anyOf 1)integerAlternative
comment.position (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.position (anyOf 2)nullAlternative
comment.reactionsModelOptionalExpand Get an issue — response body — reactions
comment.updated_atstringOptionalFormat: date-time
comment.urlstringOptionalFormat: uri
comment.userModelOptionalExpand Get an issue — response body — user

Referenced models: Get an issue — response body — user, Get an issue — response body — reactions

List public events — response body — item payload Create Event

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
full_refstringRequired within parent
master_branchstringRequired within parent
pusher_typestringRequired within parent
refstringRequired within parent
ref_typestringRequired within parent

List public events — response body — item payload Delete Event

FieldTypePresenceDescription and constraints
$objectRoot
full_refstringRequired within parent
pusher_typestringRequired within parent
refstringRequired within parent
ref_typestringRequired within parent

List public events — response body — item payload Discussion Event

FieldTypePresenceDescription and constraints
$objectRoot
actionstringRequired within parent
discussionModelRequired within parentExpand List public events — response body — item payload Discussion Event discussion

Referenced models: List public events — response body — item payload Discussion Event discussion

List public events — response body — item payload Discussion Event discussion

FieldTypePresenceDescription and constraints
$objectRootA Discussion in a repository.
active_lock_reasonJSONRequired within parent
active_lock_reason (anyOf 1)stringAlternative
active_lock_reason (anyOf 2)nullAlternative
answer_chosen_atJSONRequired within parent
answer_chosen_at (anyOf 1)stringAlternative
answer_chosen_at (anyOf 2)nullAlternative
answer_chosen_byJSONRequired within parent
answer_chosen_by (anyOf 1)objectAlternative
answer_chosen_by (anyOf 1).avatar_urlstringOptionalFormat: uri
answer_chosen_by (anyOf 1).deletedbooleanOptional
answer_chosen_by (anyOf 1).emailJSONOptional
answer_chosen_by (anyOf 1).email (anyOf 1)stringAlternative
answer_chosen_by (anyOf 1).email (anyOf 2)nullAlternative
answer_chosen_by (anyOf 1).events_urlstringOptionalFormat: uri-template
answer_chosen_by (anyOf 1).followers_urlstringOptionalFormat: uri
answer_chosen_by (anyOf 1).following_urlstringOptionalFormat: uri-template
answer_chosen_by (anyOf 1).gists_urlstringOptionalFormat: uri-template
answer_chosen_by (anyOf 1).gravatar_idstringOptional
answer_chosen_by (anyOf 1).html_urlstringOptionalFormat: uri
answer_chosen_by (anyOf 1).idJSONRequired within parent
answer_chosen_by (anyOf 1).id (anyOf 1)integerAlternative
answer_chosen_by (anyOf 1).id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
answer_chosen_by (anyOf 1).loginstringRequired within parent
answer_chosen_by (anyOf 1).namestringOptional
answer_chosen_by (anyOf 1).node_idstringOptional
answer_chosen_by (anyOf 1).organizations_urlstringOptionalFormat: uri
answer_chosen_by (anyOf 1).received_events_urlstringOptionalFormat: uri
answer_chosen_by (anyOf 1).repos_urlstringOptionalFormat: uri
answer_chosen_by (anyOf 1).site_adminbooleanOptional
answer_chosen_by (anyOf 1).starred_urlstringOptionalFormat: uri-template
answer_chosen_by (anyOf 1).subscriptions_urlstringOptionalFormat: uri
answer_chosen_by (anyOf 1).typestringOptionalKnown values: Bot, User, Organization
answer_chosen_by (anyOf 1).urlstringOptionalFormat: uri
answer_chosen_by (anyOf 1).user_view_typestringOptional
answer_chosen_by (anyOf 2)nullAlternative
answer_html_urlJSONRequired within parent
answer_html_url (anyOf 1)stringAlternative
answer_html_url (anyOf 2)nullAlternative
author_associationstringOptionalHow the author is associated with the repository.
Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER
bodystringRequired within parent
categoryobjectRequired within parent
category.created_atstringRequired within parentFormat: date-time
category.descriptionstringRequired within parent
category.emojistringRequired within parent
category.idJSONRequired within parent
category.id (anyOf 1)integerAlternative
category.id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
category.is_answerablebooleanRequired within parent
category.namestringRequired within parent
category.node_idstringOptional
category.repository_idJSONRequired within parent
category.repository_id (anyOf 1)integerAlternative
category.repository_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
category.slugstringRequired within parent
category.updated_atstringRequired within parent
commentsJSONRequired within parent
comments (anyOf 1)integerAlternative
comments (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentFormat: date-time
html_urlstringRequired within parent
idJSONRequired within parent
id (anyOf 1)integerAlternative
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
labelsarrayOptional
labels[]ModelEach itemExpand Get a label — response body
lockedbooleanRequired within parent
node_idstringRequired within parent
numberJSONRequired within parent
number (anyOf 1)integerAlternative
number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reactionsModelOptionalExpand List public events — response body — item payload Discussion Event discussion reactions
repository_urlstringRequired within parent
statestringRequired within parentThe current state of the discussion.
`converting` means that the discussion is being converted from an issue.
`transferring` means that the discussion is being transferred from another repository.
Known values: open, closed, locked, converting, transferring
state_reasonJSONRequired within parent
state_reason (anyOf 1)stringAlternativeThe reason for the current state
Known values: resolved, outdated, duplicate, reopened
state_reason (anyOf 2)nullAlternative
timeline_urlstringOptional
titlestringRequired within parent
updated_atstringRequired within parentFormat: date-time
userJSONRequired within parent
user (anyOf 1)objectAlternative
user (anyOf 1).avatar_urlstringOptionalFormat: uri
user (anyOf 1).deletedbooleanOptional
user (anyOf 1).emailJSONOptional
user (anyOf 1).email (anyOf 1)stringAlternative
user (anyOf 1).email (anyOf 2)nullAlternative
user (anyOf 1).events_urlstringOptionalFormat: uri-template
user (anyOf 1).followers_urlstringOptionalFormat: uri
user (anyOf 1).following_urlstringOptionalFormat: uri-template
user (anyOf 1).gists_urlstringOptionalFormat: uri-template
user (anyOf 1).gravatar_idstringOptional
user (anyOf 1).html_urlstringOptionalFormat: uri
user (anyOf 1).idJSONRequired within parent
user (anyOf 1).id (anyOf 1)integerAlternativeFormat: int64
user (anyOf 1).id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
user (anyOf 1).loginstringRequired within parent
user (anyOf 1).namestringOptional
user (anyOf 1).node_idstringOptional
user (anyOf 1).organizations_urlstringOptionalFormat: uri
user (anyOf 1).received_events_urlstringOptionalFormat: uri
user (anyOf 1).repos_urlstringOptionalFormat: uri
user (anyOf 1).site_adminbooleanOptional
user (anyOf 1).starred_urlstringOptionalFormat: uri-template
user (anyOf 1).subscriptions_urlstringOptionalFormat: uri
user (anyOf 1).typestringOptionalKnown values: Bot, User, Organization
user (anyOf 1).urlstringOptionalFormat: uri
user (anyOf 1).user_view_typestringOptional
user (anyOf 2)nullAlternative

Referenced models: Get a label — response body, List public events — response body — item payload Discussion Event discussion reactions

List public events — response body — item payload Discussion Event discussion reactions

FieldTypePresenceDescription and constraints
$objectRoot
+1JSONRequired within parent
+1 (anyOf 1)integerAlternative
+1 (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
-1JSONRequired within parent
-1 (anyOf 1)integerAlternative
-1 (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
confusedJSONRequired within parent
confused (anyOf 1)integerAlternative
confused (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
eyesJSONRequired within parent
eyes (anyOf 1)integerAlternative
eyes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
heartJSONRequired within parent
heart (anyOf 1)integerAlternative
heart (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hoorayJSONRequired within parent
hooray (anyOf 1)integerAlternative
hooray (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
laughJSONRequired within parent
laugh (anyOf 1)integerAlternative
laugh (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rocketJSONRequired within parent
rocket (anyOf 1)integerAlternative
rocket (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternative
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
urlstringRequired within parentFormat: uri

List public events — response body — item payload Fork Event

FieldTypePresenceDescription and constraints
$objectRoot
actionstringRequired within parent
forkeeobjectRequired within parent
forkee.allow_forkingbooleanOptional
forkee.archive_urlstringOptional
forkee.archivedbooleanOptional
forkee.assignees_urlstringOptional
forkee.blobs_urlstringOptional
forkee.branches_urlstringOptional
forkee.clone_urlstringOptional
forkee.collaborators_urlstringOptional
forkee.comments_urlstringOptional
forkee.commits_urlstringOptional
forkee.compare_urlstringOptional
forkee.contents_urlstringOptional
forkee.contributors_urlstringOptional
forkee.created_atJSONOptional
forkee.created_at (anyOf 1)stringAlternativeFormat: date-time
forkee.created_at (anyOf 2)nullAlternative
forkee.default_branchstringOptional
forkee.deployments_urlstringOptional
forkee.descriptionJSONOptional
forkee.description (anyOf 1)stringAlternative
forkee.description (anyOf 2)nullAlternative
forkee.disabledbooleanOptional
forkee.downloads_urlstringOptional
forkee.events_urlstringOptional
forkee.forkbooleanOptional
forkee.forksJSONOptional
forkee.forks (anyOf 1)integerAlternative
forkee.forks (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forkee.forks_countJSONOptional
forkee.forks_count (anyOf 1)integerAlternative
forkee.forks_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forkee.forks_urlstringOptional
forkee.full_namestringOptional
forkee.git_commits_urlstringOptional
forkee.git_refs_urlstringOptional
forkee.git_tags_urlstringOptional
forkee.git_urlstringOptional
forkee.has_discussionsbooleanOptional
forkee.has_downloadsbooleanOptional
forkee.has_issuesbooleanOptional
forkee.has_pagesbooleanOptional
forkee.has_projectsbooleanOptional
forkee.has_pull_requestsbooleanOptional
forkee.has_wikibooleanOptional
forkee.homepageJSONOptional
forkee.homepage (anyOf 1)stringAlternative
forkee.homepage (anyOf 2)nullAlternative
forkee.hooks_urlstringOptional
forkee.html_urlstringOptional
forkee.idJSONOptional
forkee.id (anyOf 1)integerAlternative
forkee.id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forkee.is_templatebooleanOptional
forkee.issue_comment_urlstringOptional
forkee.issue_events_urlstringOptional
forkee.issues_urlstringOptional
forkee.keys_urlstringOptional
forkee.labels_urlstringOptional
forkee.languageJSONOptional
forkee.language (anyOf 1)stringAlternative
forkee.language (anyOf 2)nullAlternative
forkee.languages_urlstringOptional
forkee.licenseModelOptionalExpand Create a fork — response body — license
forkee.merges_urlstringOptional
forkee.milestones_urlstringOptional
forkee.mirror_urlJSONOptional
forkee.mirror_url (anyOf 1)stringAlternative
forkee.mirror_url (anyOf 2)nullAlternative
forkee.namestringOptional
forkee.node_idstringOptional
forkee.notifications_urlstringOptional
forkee.open_issuesJSONOptional
forkee.open_issues (anyOf 1)integerAlternative
forkee.open_issues (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forkee.open_issues_countJSONOptional
forkee.open_issues_count (anyOf 1)integerAlternative
forkee.open_issues_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forkee.ownerModelOptionalExpand List users — response body — item
forkee.privatebooleanOptional
forkee.publicbooleanOptional
forkee.pull_request_creation_policystringOptionalThe policy controlling who can create pull requests: all or collaborators_only.
Known values: all, collaborators_only
forkee.pulls_urlstringOptional
forkee.pushed_atJSONOptional
forkee.pushed_at (anyOf 1)stringAlternativeFormat: date-time
forkee.pushed_at (anyOf 2)nullAlternative
forkee.releases_urlstringOptional
forkee.sizeJSONOptional
forkee.size (anyOf 1)integerAlternative
forkee.size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forkee.ssh_urlstringOptional
forkee.stargazers_countJSONOptional
forkee.stargazers_count (anyOf 1)integerAlternative
forkee.stargazers_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forkee.stargazers_urlstringOptional
forkee.statuses_urlstringOptional
forkee.subscribers_urlstringOptional
forkee.subscription_urlstringOptional
forkee.svn_urlstringOptional
forkee.tags_urlstringOptional
forkee.teams_urlstringOptional
forkee.topicsarrayOptional
forkee.topics[]stringEach item
forkee.trees_urlstringOptional
forkee.updated_atJSONOptional
forkee.updated_at (anyOf 1)stringAlternativeFormat: date-time
forkee.updated_at (anyOf 2)nullAlternative
forkee.urlstringOptional
forkee.visibilitystringOptional
forkee.watchersJSONOptional
forkee.watchers (anyOf 1)integerAlternative
forkee.watchers (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forkee.watchers_countJSONOptional
forkee.watchers_count (anyOf 1)integerAlternative
forkee.watchers_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forkee.web_commit_signoff_requiredbooleanOptional

Referenced models: Create a fork — response body — license, List users — response body — item

List public events — response body — item payload Gollum Event

FieldTypePresenceDescription and constraints
$objectRoot
pagesarrayRequired within parent
pages[]objectEach item
pages[].actionstringOptional
pages[].html_urlstringOptional
pages[].page_nameJSONOptional
pages[].page_name (anyOf 1)stringAlternative
pages[].page_name (anyOf 2)nullAlternative
pages[].shastringOptional
pages[].summaryJSONOptional
pages[].summary (anyOf 1)stringAlternative
pages[].summary (anyOf 2)nullAlternative
pages[].titleJSONOptional
pages[].title (anyOf 1)stringAlternative
pages[].title (anyOf 2)nullAlternative

List public events — response body — item payload Issue Comment Event

FieldTypePresenceDescription and constraints
$objectRoot
actionstringRequired within parent
commentModelRequired within parentExpand Get an issue comment — response body
issueModelRequired within parentExpand Get an issue — response body

Referenced models: Get an issue — response body, Get an issue comment — response body

List public events — response body — item payload Issues Event

FieldTypePresenceDescription and constraints
$objectRoot
actionstringRequired within parent
assigneeModelOptionalExpand List users — response body — item
assigneesarrayOptional
assignees[]ModelEach itemExpand List users — response body — item
issueModelRequired within parentExpand Get an issue — response body
labelModelOptionalExpand Get a label — response body
labelsarrayOptional
labels[]ModelEach itemExpand Get a label — response body

Referenced models: Get an issue — response body, Get a label — response body, List users — response body — item

List public events — response body — item payload Member Event

FieldTypePresenceDescription and constraints
$objectRoot
actionstringRequired within parent
memberModelRequired within parentExpand List users — response body — item

Referenced models: List users — response body — item

List public events — response body — item payload Public Event

FieldTypePresenceDescription and constraints
$objectRoot

List public events — response body — item payload Pull Request Event

FieldTypePresenceDescription and constraints
$objectRoot
actionstringRequired within parent
assigneeModelOptionalExpand List users — response body — item
assigneesarrayOptional
assignees[]ModelEach itemExpand List users — response body — item
labelModelOptionalExpand Get a label — response body
labelsarrayOptional
labels[]ModelEach itemExpand Get a label — response body
numberJSONRequired within parent
number (anyOf 1)integerAlternative
number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pull_requestModelRequired within parentExpand Get a check run — response body — pull requests item

Referenced models: Get a label — response body, Get a check run — response body — pull requests item, List users — response body — item

List public events — response body — item payload Pull Request Review Comment Event

FieldTypePresenceDescription and constraints
$objectRoot
actionstringRequired within parent
commentobjectRequired within parent
comment._linksobjectRequired within parent
comment._links.htmlobjectRequired within parent
comment._links.html.hrefstringRequired within parentFormat: uri-template
comment._links.pull_requestobjectRequired within parent
comment._links.pull_request.hrefstringRequired within parentFormat: uri-template
comment._links.selfobjectRequired within parent
comment._links.self.hrefstringRequired within parentFormat: uri-template
comment.bodystringRequired within parent
comment.commit_idstringRequired within parent
comment.created_atstringRequired within parentFormat: date-time
comment.diff_hunkstringRequired within parent
comment.html_urlstringRequired within parentFormat: uri
comment.idJSONRequired within parent
comment.id (anyOf 1)integerAlternative
comment.id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.in_reply_to_idJSONOptional
comment.in_reply_to_id (anyOf 1)integerAlternative
comment.in_reply_to_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.node_idstringRequired within parent
comment.original_commit_idstringRequired within parent
comment.original_positionJSONRequired within parent
comment.original_position (anyOf 1)integerAlternative
comment.original_position (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.pathstringRequired within parent
comment.positionJSONRequired within parent
comment.position (anyOf 1)JSONAlternative
comment.position (anyOf 1) (anyOf 1)integerAlternative
comment.position (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.position (anyOf 2)nullAlternative
comment.pull_request_review_idJSONRequired within parent
comment.pull_request_review_id (anyOf 1)JSONAlternative
comment.pull_request_review_id (anyOf 1) (anyOf 1)integerAlternative
comment.pull_request_review_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.pull_request_review_id (anyOf 2)nullAlternative
comment.pull_request_urlstringRequired within parentFormat: uri
comment.reactionsobjectRequired within parent
comment.reactions.+1JSONOptional
comment.reactions.+1 (anyOf 1)integerAlternative
comment.reactions.+1 (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.reactions.-1JSONOptional
comment.reactions.-1 (anyOf 1)integerAlternative
comment.reactions.-1 (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.reactions.confusedJSONOptional
comment.reactions.confused (anyOf 1)integerAlternative
comment.reactions.confused (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.reactions.eyesJSONOptional
comment.reactions.eyes (anyOf 1)integerAlternative
comment.reactions.eyes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.reactions.heartJSONOptional
comment.reactions.heart (anyOf 1)integerAlternative
comment.reactions.heart (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.reactions.hoorayJSONOptional
comment.reactions.hooray (anyOf 1)integerAlternative
comment.reactions.hooray (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.reactions.laughJSONOptional
comment.reactions.laugh (anyOf 1)integerAlternative
comment.reactions.laugh (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.reactions.rocketJSONOptional
comment.reactions.rocket (anyOf 1)integerAlternative
comment.reactions.rocket (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.reactions.total_countJSONOptional
comment.reactions.total_count (anyOf 1)integerAlternative
comment.reactions.total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.reactions.urlstringOptionalFormat: uri
comment.subject_typeJSONOptional
comment.subject_type (anyOf 1)stringAlternative
comment.subject_type (anyOf 2)nullAlternative
comment.updated_atstringRequired within parentFormat: date-time
comment.urlstringRequired within parentFormat: uri
comment.userJSONRequired within parent
comment.user (anyOf 1)objectAlternative
comment.user (anyOf 1).avatar_urlstringOptionalFormat: uri
comment.user (anyOf 1).deletedbooleanOptional
comment.user (anyOf 1).emailJSONOptional
comment.user (anyOf 1).email (anyOf 1)stringAlternative
comment.user (anyOf 1).email (anyOf 2)nullAlternative
comment.user (anyOf 1).events_urlstringOptionalFormat: uri-template
comment.user (anyOf 1).followers_urlstringOptionalFormat: uri
comment.user (anyOf 1).following_urlstringOptionalFormat: uri-template
comment.user (anyOf 1).gists_urlstringOptionalFormat: uri-template
comment.user (anyOf 1).gravatar_idstringOptional
comment.user (anyOf 1).html_urlstringOptionalFormat: uri
comment.user (anyOf 1).idJSONOptional
comment.user (anyOf 1).id (anyOf 1)integerAlternativeFormat: int64
comment.user (anyOf 1).id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comment.user (anyOf 1).loginstringOptional
comment.user (anyOf 1).namestringOptional
comment.user (anyOf 1).node_idstringOptional
comment.user (anyOf 1).organizations_urlstringOptionalFormat: uri
comment.user (anyOf 1).received_events_urlstringOptionalFormat: uri
comment.user (anyOf 1).repos_urlstringOptionalFormat: uri
comment.user (anyOf 1).site_adminbooleanOptional
comment.user (anyOf 1).starred_urlstringOptionalFormat: uri-template
comment.user (anyOf 1).subscriptions_urlstringOptionalFormat: uri
comment.user (anyOf 1).typestringOptionalKnown values: Bot, User, Organization
comment.user (anyOf 1).urlstringOptionalFormat: uri
comment.user (anyOf 1).user_view_typestringOptional
comment.user (anyOf 2)nullAlternative
pull_requestModelRequired within parentExpand Get a check run — response body — pull requests item

Referenced models: Get a check run — response body — pull requests item

List public events — response body — item payload Pull Request Review Event

FieldTypePresenceDescription and constraints
$objectRoot
actionstringRequired within parent
pull_requestModelRequired within parentExpand Get a check run — response body — pull requests item
reviewobjectRequired within parent
review._linksobjectOptional
review._links.htmlobjectRequired within parent
review._links.html.hrefstringRequired within parent
review._links.pull_requestobjectRequired within parent
review._links.pull_request.hrefstringRequired within parent
review.bodystringOptional
review.commit_idstringOptional
review.html_urlstringOptionalFormat: uri
review.idJSONOptional
review.id (anyOf 1)integerAlternative
review.id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
review.node_idstringOptional
review.pull_request_urlstringOptionalFormat: uri
review.statestringOptional
review.submitted_atJSONOptional
review.submitted_at (anyOf 1)stringAlternative
review.submitted_at (anyOf 2)nullAlternative
review.updated_atstringOptional
review.userModelOptionalExpand Get an issue — response body — user

Referenced models: Get an issue — response body — user, Get a check run — response body — pull requests item

List public events — response body — item payload Push Event

FieldTypePresenceDescription and constraints
$objectRoot
beforestringRequired within parent
headstringRequired within parent
push_idJSONRequired within parent
push_id (anyOf 1)integerAlternative
push_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
refstringRequired within parent
repository_idJSONRequired within parent
repository_id (anyOf 1)integerAlternative
repository_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List public events — response body — item payload Release Event

FieldTypePresenceDescription and constraints
$objectRoot
actionstringRequired within parent
releaseJSONRequired within parent
release (allOf 1)ModelAll variants applyExpand Get a release — response body
release (allOf 2)objectAll variants apply
release (allOf 2).is_short_description_html_truncatedbooleanOptional
release (allOf 2).short_description_htmlstringOptional

Referenced models: Get a release — response body

List public events — response body — item payload Watch Event

FieldTypePresenceDescription and constraints
$objectRoot
actionstringRequired within parent

List repositories starred by a user — response body — array item

FieldTypePresenceDescription and constraints
$objectRootStarred Repository
repoModelRequired within parentExpand List repositories for the authenticated user — response body — item
starred_atstringRequired within parentFormat: date-time

Referenced models: List repositories for the authenticated user — response body — item

List stargazers — response body — array item

FieldTypePresenceDescription and constraints
$objectRootStargazer
starred_atstringRequired within parentFormat: date-time
userModelRequired within parentExpand Get an issue — response body — user

Referenced models: Get an issue — response body — user

Set a thread subscription — response body

FieldTypePresenceDescription and constraints
$objectRootThread Subscription
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeFormat: date-time
created_at (anyOf 2)nullAlternative
ignoredbooleanRequired within parent
reasonJSONRequired within parent
reason (anyOf 1)stringAlternative
reason (anyOf 2)nullAlternative
repository_urlstringOptionalFormat: uri
subscribedbooleanRequired within parent
thread_urlstringOptionalFormat: uri
urlstringRequired within parentFormat: uri

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.