팔로워

REST API를 사용하여 인증된 사용자의 팔로워에 대한 정보를 가져옵니다.

팔로워 관리 정보

요청 URL에 매개 변수가 {username} 포함되어 있지 않으면 로그인한 사용자에 대한 응답이 됩니다.{ % ifversion fpt or ghes or ghec %} 사용자가 2단계 인증을 사용할 수 있는지 여부와 같은 추가 개인 정보는 OAuth user 를 통해 인증될 때 범위에 포함됩니다.{ % endif %}

List followers of the authenticated user

Lists the people following the authenticated user.

"List followers of the authenticated user"에 대한 매개 변수

헤더
Name, 형식, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.
쿼리 매개 변수
Name, 형식, 설명
`per_page` integer The number of results per page (max 100). 기본값: `30`
`page` integer Page number of the results to fetch. 기본값: `1`

"List followers of the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

"List followers of the authenticated user"에 대한 코드 샘플

get/user/followers

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/user/followers

Response

Status: 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
  }
]

List the people the authenticated user follows

Lists the people who the authenticated user follows.

"List the people the authenticated user follows"에 대한 매개 변수

헤더
Name, 형식, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.
쿼리 매개 변수
Name, 형식, 설명
`per_page` integer The number of results per page (max 100). 기본값: `30`
`page` integer Page number of the results to fetch. 기본값: `1`

"List the people the authenticated user follows"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

"List the people the authenticated user follows"에 대한 코드 샘플

get/user/following

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/user/following

Response

Status: 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
  }
]

Check if a person is followed by the authenticated user

"Check if a person is followed by the authenticated user"에 대한 매개 변수

헤더
Name, 형식, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, 형식, 설명
`username` string 필수 The handle for the GitHub user account.

"Check if a person is followed by the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`204`	if the person is followed by the authenticated user
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	if the person is not followed by the authenticated user

"Check if a person is followed by the authenticated user"에 대한 코드 샘플

get/user/following/{username}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/user/following/USERNAME

if the person is followed by the authenticated user

Status: 204

Follow a user

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.

"Follow a user"에 대한 매개 변수

헤더
Name, 형식, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, 형식, 설명
`username` string 필수 The handle for the GitHub user account.

"Follow a user"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

"Follow a user"에 대한 코드 샘플

put/user/following/{username}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/user/following/USERNAME

Response

Status: 204

Unfollow a user

Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.

"Unfollow a user"에 대한 매개 변수

헤더
Name, 형식, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, 형식, 설명
`username` string 필수 The handle for the GitHub user account.

"Unfollow a user"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

"Unfollow a user"에 대한 코드 샘플

delete/user/following/{username}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/user/following/USERNAME

Response

Status: 204

List followers of a user

에서 작동 GitHub Apps

Lists the people following the specified user.

"List followers of a user"에 대한 매개 변수

헤더
Name, 형식, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, 형식, 설명
`username` string 필수 The handle for the GitHub user account.
쿼리 매개 변수
Name, 형식, 설명
`per_page` integer The number of results per page (max 100). 기본값: `30`
`page` integer Page number of the results to fetch. 기본값: `1`

"List followers of a user"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`200`	OK

"List followers of a user"에 대한 코드 샘플

get/users/{username}/followers

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/users/USERNAME/followers

Response

Status: 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
  }
]

List the people a user follows

에서 작동 GitHub Apps

Lists the people who the specified user follows.

"List the people a user follows"에 대한 매개 변수

헤더
Name, 형식, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, 형식, 설명
`username` string 필수 The handle for the GitHub user account.
쿼리 매개 변수
Name, 형식, 설명
`per_page` integer The number of results per page (max 100). 기본값: `30`
`page` integer Page number of the results to fetch. 기본값: `1`

"List the people a user follows"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`200`	OK

"List the people a user follows"에 대한 코드 샘플

get/users/{username}/following

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/users/USERNAME/following

Response

Status: 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
  }
]

Check if a user follows another user

에서 작동 GitHub Apps

"Check if a user follows another user"에 대한 매개 변수

헤더
Name, 형식, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
Name, 형식, 설명
`username` string 필수 The handle for the GitHub user account.
`target_user` string 필수

"Check if a user follows another user"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`204`	if the user follows the target user
`404`	if the user does not follow the target user

"Check if a user follows another user"에 대한 코드 샘플

get/users/{username}/following/{target_user}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/users/USERNAME/following/TARGET_USER

if the user follows the target user

Status: 204