REST API 现在已版本化。 有关更多信息，请参阅 "关于 API 版本控制."

关注者的 REST API 端点

使用 REST API 获取有关已认证用户关注者的信息。

关于关注者管理

如果请求 URL 不包含 {username} 参数，则响应将针对已登录的用户（并且您必须在请求中传递 身份验证信息）。通过 OAuth 使用 user 范围进行身份验证时，将包含其他私人信息，例如用户是否启用了双因素身份验证。

列出已认证用户的关注者

列出关注已认证用户的人。

用于“列出已认证用户的关注者”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • "关注者" 用户权限（读取）

参数 for "列出已认证用户的关注者"

头部
accept string

建议设置为 application/vnd.github+json。

查询参数
per_page integer

每页结果数（最大 100）。更多信息，请查看 "在 REST API 中使用分页"。

默认: 30

page integer

要获取的结果页码。更多信息，请查看 "在 REST API 中使用分页"。

默认: 1

HTTP 响应状态码 for "列出已认证用户的关注者"

状态码描述
200

OK

304

未修改

401

需要身份验证

403

禁止

代码示例 for "列出已认证用户的关注者"

请求示例

get/user/followers
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/followers

响应

状态: 200
[ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ]

列出已认证用户关注的人员

列出已认证用户关注的人员。

用于“列出已认证用户关注的人员”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • "关注者" 用户权限（读取）

用于“列出已认证用户关注的人员”的参数

头部
accept string

建议设置为 application/vnd.github+json。

查询参数
per_page integer

每页结果数（最大 100）。更多信息，请查看 "在 REST API 中使用分页"。

默认: 30

page integer

要获取的结果页码。更多信息，请查看 "在 REST API 中使用分页"。

默认: 1

用于“列出已认证用户关注的人员”的 HTTP 响应状态码

状态码描述
200

OK

304

未修改

401

需要身份验证

403

禁止

用于“列出已认证用户关注的人员”的代码示例

请求示例

get/user/following
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/following

响应

状态: 200
[ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ]

检查已认证用户是否关注某人

用于“检查已认证用户是否关注某人”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • "关注者" 用户权限（读取）

用于“检查已认证用户是否关注某人”的参数

头部
accept string

建议设置为 application/vnd.github+json。

路径参数
username string 必需

GitHub 用户帐户的句柄。

用于“检查已认证用户是否关注某人”的 HTTP 响应状态码

状态码描述
204

如果已认证用户关注此人

304

未修改

401

需要身份验证

403

禁止

404

如果已认证用户未关注此人

用于“检查已认证用户是否关注某人”的代码示例

请求示例

get/user/following/{username}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/following/USERNAME

如果已认证用户关注此人

状态：204

关注用户

请注意，您需要将 Content-Length 设置为零才能调用此端点。有关更多信息，请参阅“HTTP 动词”。

OAuth 应用程序令牌和个人访问令牌（经典）需要 user:follow 范围才能使用此端点。

用于“关注用户”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “关注者”用户权限（写入）

用于“关注用户”的参数

头部
accept string

建议设置为 application/vnd.github+json。

路径参数
username string 必需

GitHub 用户帐户的句柄。

用于“关注用户”的 HTTP 响应状态码

状态码描述
204

无内容

304

未修改

401

需要身份验证

403

禁止

404

资源未找到

"关注用户" 代码示例

请求示例

put/user/following/{username}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/following/USERNAME

响应

状态：204

取消关注用户

OAuth 应用程序令牌和个人访问令牌（经典）需要 user:follow 范围才能使用此端点。

"取消关注用户" 的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌必须具有以下权限集

  • “关注者”用户权限（写入）

"取消关注用户" 的参数

头部
accept string

建议设置为 application/vnd.github+json。

路径参数
username string 必需

GitHub 用户帐户的句柄。

"取消关注用户" 的 HTTP 响应状态码

状态码描述
204

无内容

304

未修改

401

需要身份验证

403

禁止

404

资源未找到

"取消关注用户" 代码示例

请求示例

delete/user/following/{username}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/following/USERNAME

响应

状态：204

列出用户的关注者

列出关注指定用户的用户。

"列出用户的关注者" 的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌不需要任何权限。

"列出用户的关注者" 的参数

头部
accept string

建议设置为 application/vnd.github+json。

路径参数
username string 必需

GitHub 用户帐户的句柄。

查询参数
per_page integer

每页结果数（最大 100）。更多信息，请查看 "在 REST API 中使用分页"。

默认: 30

page integer

要获取的结果页码。更多信息，请查看 "在 REST API 中使用分页"。

默认: 1

"列出用户的关注者" 的 HTTP 响应状态码

状态码描述
200

OK

"列出用户的关注者" 代码示例

请求示例

get/users/{username}/followers
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/users/USERNAME/followers

响应

状态: 200
[ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ]

列出用户关注的人

列出指定用户关注的人。

"列出用户关注的人" 的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌不需要任何权限。

"列出用户关注的人" 的参数

头部
accept string

建议设置为 application/vnd.github+json。

路径参数
username string 必需

GitHub 用户帐户的句柄。

查询参数
per_page integer

每页结果数（最大 100）。更多信息，请查看 "在 REST API 中使用分页"。

默认: 30

page integer

要获取的结果页码。更多信息，请查看 "在 REST API 中使用分页"。

默认: 1

"列出用户关注的人" 的 HTTP 响应状态码

状态码描述
200

OK

"列出用户关注的人" 代码示例

请求示例

get/users/{username}/following
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/users/USERNAME/following

响应

状态: 200
[ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ]

检查用户是否关注另一个用户

"检查用户是否关注另一个用户" 的细粒度访问令牌

此端点适用于以下细粒度令牌类型

细粒度令牌不需要任何权限。

检查用户是否关注另一个用户参数

头部
accept string

建议设置为 application/vnd.github+json。

路径参数
username string 必需

GitHub 用户帐户的句柄。

target_user 字符串 必填

检查用户是否关注另一个用户的 HTTP 响应状态码

状态码描述
204

如果用户关注目标用户

404

如果用户没有关注目标用户

检查用户是否关注另一个用户的代码示例

请求示例

获取/users/{username}/following/{target_user}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/users/USERNAME/following/TARGET_USER

如果用户关注目标用户

状态：204