10BC0 Clarify pagination for /users · ostegott1/developer.github.com@87883eb · GitHub
[go: up one dir, main page]

Skip to content

Commit 87883eb

Browse files
committed
Clarify pagination for /users
This API endpoint does not use the `page` parameter for pagination. /cc github#259
1 parent c54f77d commit 87883eb

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

content/v3.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,8 @@ see [events](http://developer.github.com/v3/activity/events/) for example.
249249
$ curl https://api.github.com/user/repos?page=2&per_page=100
250250
</pre>
251251

252+
### Link Header
253+
252254
The pagination info is included in [the Link
253255
header](http://tools.ietf.org/html/rfc5988). It is important to
254256
follow these Link header values instead of constructing your own URLs. In some

content/v3/users.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,11 @@ bio
7676
## Get all users
7777

7878
This provides a dump of every user, in the order that they signed up for
79-
GitHub. Note that the `since` parameter is required in addition to the
80-
`page` parameter when using pagination.
79+
GitHub.
80+
81+
Note: Pagination is powered exclusively by the `since` parameter.
82+
Use the [Link header](/v3/#link-header) to get the URL for the next page of
83+
users.
8184

8285
GET /users
8386

0 commit comments

Comments
 (0)
0