user_issues
Creates, updates, deletes, gets or lists a user_issues resource.
Overview
| Name | user_issues |
| Type | Resource |
| Id | github.issues.user_issues |
Fields
The following fields are returned by SELECT queries:
- list_for_authenticated_user
Response
| Name | Datatype | Description |
|---|---|---|
id | integer (int64) | |
node_id | string | |
active_lock_reason | string | |
assignee | object | A GitHub user. (title: Simple User) |
assignees | array | |
author_association | string | How the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER) |
body | string | Contents of the issue (example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?) |
body_html | string | |
body_text | string | |
closed_at | string (date-time) | |
closed_by | object | A GitHub user. (title: Simple User) |
comments | integer | |
comments_url | string (uri) | |
created_at | string (date-time) | |
draft | boolean | |
events_url | string (uri) | |
html_url | string (uri) | |
issue_dependencies_summary | object | (title: Issue Dependencies Summary) |
issue_field_values | array | |
labels | array | 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 |
labels_url | string | |
locked | boolean | |
milestone | object | A collection of related issues and pull requests. (title: Milestone) |
number | integer | Number uniquely identifying the issue within its repository |
parent_issue_url | string (uri) | URL to get the parent issue of this issue, if it is a sub-issue |
performed_via_github_app | object | 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. (title: GitHub app) |
pinned_comment | object | Comments provide a way for people to collaborate on an issue. (title: Issue Comment) |
pull_request | object | |
reactions | object | (title: Reaction Rollup) |
repository | object | A repository on GitHub. (title: Repository) |
repository_url | string (uri) | |
state | string | State of the issue; either 'open' or 'closed' (example: open) |
state_reason | string | The reason for the current state (completed, reopened, not_planned, duplicate) (example: not_planned) |
sub_issues_summary | object | (title: Sub-issues Summary) |
timeline_url | string (uri) | |
title | string | Title of the issue (example: Widget creation fails in Safari on OS X 10.8) |
type | object | The type of issue. (title: Issue Type) |
updated_at | string (date-time) | |
url | string (uri) | URL for the issue (example: https://api.github.com/repositories/42/issues/1) |
user | object | A GitHub user. (title: Simple User) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_for_authenticated_user | select | filter, state, labels, sort, direction, since, per_page, page | List issues across owned and member repositories assigned to the authenticated user. > [!NOTE] > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.- application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.- application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.- application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
direction | string | The direction to sort the results by. |
filter | string | Indicates which sorts of issues to return. assigned means issues assigned to you. created means issues created by you. mentioned means issues mentioning you. subscribed means issues you're subscribed to updates for. all or repos means all issues you can see, regardless of participation or creation. |
labels | string | A list of comma separated label names. Example: bug,ui,@high |
page | integer | The page number of the results to fetch. For more information, see "Using pagination in the REST API." |
per_page | integer | The number of results per page (max 100). For more information, see "Using pagination in the REST API." |
since | string (date-time) | Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. |
sort | string | What to sort results by. |
state | string | Indicates the state of the issues to return. |
SELECT examples
- list_for_authenticated_user
List issues across owned and member repositories assigned to the authenticated user.
> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.
This endpoint supports the following custom media types. For more information, see "Media types."
- application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
- application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
- application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
- application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
SELECT
id,
node_id,
active_lock_reason,
assignee,
assignees,
author_association,
body,
body_html,
body_text,
closed_at,
closed_by,
comments,
comments_url,
created_at,
draft,
events_url,
html_url,
issue_dependencies_summary,
issue_field_values,
labels,
labels_url,
locked,
milestone,
number,
parent_issue_url,
performed_via_github_app,
pinned_comment,
pull_request,
reactions,
repository,
repository_url,
state,
state_reason,
sub_issues_summary,
timeline_url,
title,
type,
updated_at,
url,
user
FROM github.issues.user_issues
WHERE filter = '{{ filter }}'
AND state = '{{ state }}'
AND labels = '{{ labels }}'
AND sort = '{{ sort }}'
AND direction = '{{ direction }}'
AND since = '{{ since }}'
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;