Puntos de conexión de la API de REST para seguidores

Acerca de la administración de seguidores

Si una dirección URL de solicitud no incluye un parámetro {username}, la respuesta será para el usuario que ha iniciado sesión (y debe pasar la información de autenticación con la solicitud). Información privada adicional, como si un usuario tiene habilitada la autenticación en dos fases, se incluye cuando se autentica a través de OAuth con el ámbito user.

List followers of the authenticated user

Lists the people following the authenticated user.

Tokens de acceso específicos para "List followers of the authenticated user"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Followers" user permissions (read)

Parámetros para "List followers of the authenticated user"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de consulta
Nombre, Tipo, Descripción
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: `1`

Códigos de estado de respuesta HTTP para "List followers of the authenticated user"

status code	Descripción
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Ejemplos de código para "List followers of the authenticated user"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

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.

Tokens de acceso específicos para "List the people the authenticated user follows"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Followers" user permissions (read)

Parámetros para "List the people the authenticated user follows"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de consulta
Nombre, Tipo, Descripción
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: `1`

Códigos de estado de respuesta HTTP para "List the people the authenticated user follows"

status code	Descripción
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Ejemplos de código para "List the people the authenticated user follows"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

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

Tokens de acceso específicos para "Check if a person is followed by the authenticated user"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Followers" user permissions (read)

Parámetros para "Check if a person is followed by the authenticated user"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`username` string Requerido The handle for the GitHub user account.

Códigos de estado de respuesta HTTP para "Check if a person is followed by the authenticated user"

status code	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 para "Check if a person is followed by the authenticated user"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

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."

OAuth app tokens and personal access tokens (classic) need the user:follow scope to use this endpoint.

Tokens de acceso específicos para "Follow a user"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Followers" user permissions (write)

Parámetros para "Follow a user"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`username` string Requerido The handle for the GitHub user account.

Códigos de estado de respuesta HTTP para "Follow a user"

status code	Descripción
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Follow a user"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

Status: 204

Unfollow a user

OAuth app tokens and personal access tokens (classic) need the user:follow scope to use this endpoint.

Tokens de acceso específicos para "Unfollow a user"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Followers" user permissions (write)

Parámetros para "Unfollow a user"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`username` string Requerido The handle for the GitHub user account.

Códigos de estado de respuesta HTTP para "Unfollow a user"

status code	Descripción
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Ejemplos de código para "Unfollow a user"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

Response

Status: 204

List followers of a user

Lists the people following the specified user.

Tokens de acceso específicos para "List followers of a user"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado no requiere ningún permiso.

Este punto de conexión se puede usar sin autenticación si solo se solicitan recursos públicos.

Parámetros para "List followers of a user"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`username` string Requerido 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). For more information, see "Using pagination in the REST API." Valor predeterminado: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: `1`

Códigos de estado de respuesta HTTP para "List followers of a user"

status code	Descripción
`200`	OK

Ejemplos de código para "List followers of a user"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

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

Lists the people who the specified user follows.

Tokens de acceso específicos para "List the people a user follows"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado no requiere ningún permiso.

Este punto de conexión se puede usar sin autenticación si solo se solicitan recursos públicos.

Parámetros para "List the people a user follows"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`username` string Requerido 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). For more information, see "Using pagination in the REST API." Valor predeterminado: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: `1`

Códigos de estado de respuesta HTTP para "List the people a user follows"

status code	Descripción
`200`	OK

Ejemplos de código para "List the people a user follows"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

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

Tokens de acceso específicos para "Check if a user follows another user"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado no requiere ningún permiso.

Este punto de conexión se puede usar sin autenticación si solo se solicitan recursos públicos.

Parámetros para "Check if a user follows another user"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`username` string Requerido The handle for the GitHub user account.
`target_user` string Requerido

Códigos de estado de respuesta HTTP para "Check if a user follows another user"

status code	Descripción
`204`	if the user follows the target user
`404`	if the user does not follow the target user

Ejemplos de código para "Check if a user follows another user"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/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

if the user follows the target user

Status: 204