GitHub v3 REST API

List timeline events for an issue

get
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/issues/{issue_number}/timeline

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
issue_numberintegerrequired

issue_number parameter

Response

application/json

Response

Timeline Eventarray[object]

Timeline Event

Any Of
idintegerrequired
node_idstringrequired
urlstringrequired
actorobjectrequired

Simple User

Show Child Parameters
eventstringrequired
commit_idstring | nullrequired
commit_urlstring | nullrequired
created_atstringrequired
performed_via_github_appobject | nullrequired

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
labelobjectrequired
Show Child Parameters
get/repos/{owner}/{repo}/issues/{issue_number}/timeline
 
application/json

List labels for a repository

get
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/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

Response

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}/labels
 
application/json

Create a label

post
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/labels

Path Parameters

ownerstringrequired
repostringrequired

Body

application/json
namestringrequired

The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see “Emoji cheat sheet.”

colorstring

The hexadecimal color code for the label, without the leading #.

descriptionstring

A short description of the label. Must be 100 characters or fewer.

Response

application/json

Response

Label

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

post/repos/{owner}/{repo}/labels

Body

{ "name": "bug", "description": "Something isn't working", "color": "f29513" }
 
application/json

Get a label

get
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/labels/{name}

Path Parameters

ownerstringrequired
repostringrequired
namestringrequired

Response

application/json

Response

Label

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}/labels/{name}
 
application/json

Update a label

patch
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/labels/{name}

Path Parameters

ownerstringrequired
repostringrequired
namestringrequired

Body

application/json
new_namestring

The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see “Emoji cheat sheet.”

colorstring

The hexadecimal color code for the label, without the leading #.

descriptionstring

A short description of the label. Must be 100 characters or fewer.

Response

200 application/json

Response

Label

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

patch/repos/{owner}/{repo}/labels/{name}

Body

{ "new_name": "bug :bug:", "description": "Small bug fix required", "color": "b01f26" }
 
200 application/json