Seguidores - GitHub Enterprise Server 3.1 Docs

About the Followers API

Many of the resources on this API provide a shortcut for getting information about the currently authenticated user. Si una URL de solicitud no incluye un parámetro de {username}, entonces la respuesta será para el usuario que inició sesión (y debes pasar la información de autenticación con tu solicitud). La información privada adicional, tal como si un usuario tiene habilitada la autenticación bifactorial, se incluye cuando se está autenticado con la autenticación básica o a través de OAuth, con el alcance de user.

List followers of the authenticated user

Lists the people following the authenticated user.

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de consulta
Nombre, Tipo, Descripción
`per_page`integer The number of results per page (max 100). Predeterminado: `30`
`page`integer Page number of the results to fetch. Predeterminado: `1`

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Ejemplos de código

get/user/followers

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://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.

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de consulta
Nombre, Tipo, Descripción
`per_page`integer The number of results per page (max 100). Predeterminado: `30`
`page`integer Page number of the results to fetch. Predeterminado: `1`

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Ejemplos de código

get/user/following

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://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

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`username`stringRequerido The handle for the GitHub user account.

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`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

Ejemplos de código

get/user/following/{username}

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://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.

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`username`stringRequerido The handle for the GitHub user account.

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Ejemplos de código

put/user/following/{username}

curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://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.

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`username`stringRequerido The handle for the GitHub user account.

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Ejemplos de código

delete/user/following/{username}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/user/following/USERNAME

Response

Status: 204

List followers of a user

Funciona con GitHub Apps

Lists the people following the specified user.

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`username`stringRequerido The handle for the GitHub user account.
Parámetros de consulta
Nombre, Tipo, Descripción
`per_page`integer The number of results per page (max 100). Predeterminado: `30`
`page`integer Page number of the results to fetch. Predeterminado: `1`

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK

Ejemplos de código

get/users/{username}/followers

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://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

Funciona con GitHub Apps

Lists the people who the specified user follows.

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`username`stringRequerido The handle for the GitHub user account.
Parámetros de consulta
Nombre, Tipo, Descripción
`per_page`integer The number of results per page (max 100). Predeterminado: `30`
`page`integer Page number of the results to fetch. Predeterminado: `1`

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`200`	OK

Ejemplos de código

get/users/{username}/following

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://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

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`username`stringRequerido The handle for the GitHub user account.
`target_user`stringRequerido

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`204`	if the user follows the target user
`404`	if the user does not follow the target user

Ejemplos de código

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

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/users/USERNAME/following/TARGET_USER

if the user follows the target user

Status: 204