You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+70-7Lines changed: 70 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,7 @@ This document outlines the setup and usage of ZenHub's public API: a RESTful API
6
6
-[Authentication](#authentication)
7
7
-[Endpoints](#endpoints)
8
8
-[Get issue data](#get-issue-data)
9
+
-[Get issue events](#get-issue-events)
9
10
-[Get the ZenHub Board data for a repository](#get-the-zenhub-board-data-for-a-repository)
10
11
-[API limits](#api-limits)
11
12
-[Errors](#errors)
@@ -26,16 +27,14 @@ The token is sent in the `X-Authentication-Token` header. For example, using `cu
26
27
GET https://api.zenhub.io/p1/repositories/:repo_id/issues/:issue_number
27
28
```
28
29
29
-
Remember, the`repo_id` is the ID of the repository, not the full name. For example, the ID of the `ZenHubIO/support` repository is `13550592`.
30
-
You can use [GitHub's API](https://developer.github.com/v3/repos/#get) to find out the ID of your repository.
30
+
Please note:`repo_id` is the ID of the repository, not its full name. For example, the ID of the `ZenHubIO/support` repository is `13550592`.
31
+
To find out the ID of your repository, use [GitHub's API](https://developer.github.com/v3/repos/#get).
31
32
32
-
The issue number is the same as displayed in your GitHub Issues page.
33
+
Issue number is the same as displayed in your GitHub Issues page. For example, to fetch the [Zenhub Public API](https://github.com/ZenHubIO/support/issues/172) issue information, the URL would be `https://api.zenhub.io/p1/repositories/13550592/issues/172`.
33
34
34
-
For example, to fetch the [Zenhub Public API](https://github.com/ZenHubIO/support/issues/172) issue information, the URL would be `https://api.zenhub.io/p1/repositories/13550592/issues/172`.
35
+
The endpoint returns that issue's assigned _Time Estimate_ (if applicable), its _Pipeline_ in the Board, as well as any _+1s_.
35
36
36
-
The endpoint returns that issue's assigned _Time Estimate_, the _Pipeline_ where it sits in the Board, as well as any _+1s_.
37
-
38
-
This is an example of returned JSON data:
37
+
Here is an example of returned JSON data:
39
38
```json
40
39
{
41
40
"estimate": {
@@ -53,6 +52,70 @@ This is an example of returned JSON data:
53
52
}
54
53
```
55
54
55
+
### Get issue events
56
+
57
+
```
58
+
GET https://api.zenhub.io/p1/repositories/:repo_id/issues/:issue_number/events
59
+
```
60
+
61
+
Please note: `repo_id` is the ID of the repository, not its full name. For example, the ID of the `ZenHubIO/support` repository is `13550592`.
62
+
To find out the ID of your repository, use [GitHub's API](https://developer.github.com/v3/repos/#get).
63
+
64
+
Issue number is the same as displayed in your GitHub Issues page. For example, to fetch the [Zenhub Public API](https://github.com/ZenHubIO/support/issues/172) issue information, the URL would be `https://api.zenhub.io/p1/repositories/13550592/issues/172`.
65
+
66
+
The endpoint returns that issue's events, sorted by most recent. Each event contains the _User ID_ of the person who performed the change, the _Creation Date_ of the event, and _Type_. Type can be either `estimateIssue` or `transferIssue`. Old and new values are included for both event types.
0 commit comments