Search
K
GitHub v3 REST API

List labels for issues in a milestone

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/milestones/{milestone_number}/labels

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

ownerstringrequired
repostringrequired
milestone_numberintegerrequired

milestone_number parameter

Response

200 application/json

Response

Color-coded labels help you categorize and filter your issues (just like labels in Gmail).

idinteger(int64)required

Example:208045946

node_idstringrequired

Example:MDU6TGFiZWwyMDgwNDU5NDY=

urlstring(uri)required

URL for the label

Example:https://api.github.com/repositories/42/labels/bug

namestringrequired

The name of the label.

Example:bug

descriptionstring | nullrequired

Example:Something isn't working

colorstringrequired

6-character hex code, without the leading #, identifying the color

Example:FFFFFF

defaultbooleanrequired

Example:true

get/repos/{owner}/{repo}/milestones/{milestone_number}/labels
 
200 application/json

List user account issues assigned to the authenticated user

List issues across owned and member repositories assigned to the authenticated user.

Note: GitHub’s REST API v3 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.

get
http://HOSTNAME/api/v3/user/issues

Query Parameters

filterstring

Indicates which sorts of issues to return. Can be one of:
* assigned: Issues assigned to you
* created: Issues created by you
* mentioned: Issues mentioning you
* subscribed: Issues you’re subscribed to updates for
* all or repos: All issues the authenticated user can see, regardless of participation or creation

Allowed values:assignedcreatedmentionedsubscribedreposall

Default:assigned

statestring

Indicates the state of the issues to return. Can be either open, closed, or all.

Allowed values:openclosedall

Default:open

labelsstring

A list of comma separated label names. Example: bug,ui,@high

sortstring

What to sort results by. Can be either created, updated, comments.

Allowed values:createdupdatedcomments

Default:created

directionstring

One of asc (ascending) or desc (descending).

Allowed values:ascdesc

Default:desc

sincestring(date-time)

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Response

application/json

Response

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

idintegerrequired
node_idstringrequired
urlstring(uri)required

URL for the issue

Example:https://api.github.com/repositories/42/issues/1

repository_urlstring(uri)required
labels_urlstringrequired
comments_urlstring(uri)required
events_urlstring(uri)required
html_urlstring(uri)required
numberintegerrequired

Number uniquely identifying the issue within its repository

Example:42

statestringrequired

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

Example:open

titlestringrequired

Title of the issue

Example:Widget creation fails in Safari on OS X 10.8

bodystring | null

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?

userobject | nullrequired

Simple User

Show Child Parameters
labelsOne Of
arrayrequired

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

Example:["bug","registration"]

Variant 1string
assigneeobject | nullrequired

Simple User

Show Child Parameters
assigneesarray | null[object]

Simple User

Show Child Parameters
milestoneobject | nullrequired

A collection of related issues and pull requests.

Show Child Parameters
lockedbooleanrequired
active_lock_reasonstring | null
commentsintegerrequired
pull_requestobject
Show Child Parameters
closed_atstring | null(date-time)required
created_atstring(date-time)required
updated_atstring(date-time)required
draftboolean
closed_byobject | null

Simple User

Show Child Parameters
body_htmlstring
body_textstring
timeline_urlstring(uri)
repositoryobject

A git repository

Show Child Parameters
performed_via_github_appobject | null

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.

Show Child Parameters
author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

reactionsobject
Show Child Parameters
get/user/issues
 
application/json

Get all commonly used licenses

get
http://HOSTNAME/api/v3/licenses

Query Parameters

featuredboolean
per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Response

application/json

Response

License Simple

keystringrequired

Example:mit

namestringrequired

Example:MIT License

urlstring | null(uri)required

Example:https://api.github.com/licenses/mit

spdx_idstring | nullrequired

Example:MIT

node_idstringrequired

Example:MDc6TGljZW5zZW1pdA==

html_urlstring(uri)
get/licenses
 
application/json

Get a license

get
http://HOSTNAME/api/v3/licenses/{license}

Path Parameters

licensestringrequired

Response

application/json

Response

License

License

keystringrequired

Example:mit

namestringrequired

Example:MIT License

spdx_idstring | nullrequired

Example:MIT

urlstring | null(uri)required

Example:https://api.github.com/licenses/mit

node_idstringrequired

Example:MDc6TGljZW5zZW1pdA==

html_urlstring(uri)required

Example:http://choosealicense.com/licenses/mit/

descriptionstringrequired

Example:A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.

implementationstringrequired

Example:Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.

permissionsarray[string]required

Example:["commercial-use","modifications","distribution","sublicense","private-use"]

conditionsarray[string]required

Example:["include-copyright"]

limitationsarray[string]required

Example:["no-liability"]

bodystringrequired

Example: The MIT License (MIT) Copyright (c) [year] [fullname] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

featuredbooleanrequired

Example:true

get/licenses/{license}
 
application/json

Get the license for a repository

This method returns the contents of the repository’s license file, if one is detected.

Similar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/license

Path Parameters

ownerstringrequired
repostringrequired

Response

200 application/json

Response

License Content

License Content

namestringrequired
pathstringrequired
shastringrequired
sizeintegerrequired
urlstring(uri)required
html_urlstring | null(uri)required
git_urlstring | null(uri)required
download_urlstring | null(uri)required
typestringrequired
contentstringrequired
encodingstringrequired
_linksobjectrequired
Show Child Parameters
licenseobject | nullrequired

License Simple

Show Child Parameters
get/repos/{owner}/{repo}/license
 
200 application/json