REST API endpoints for blocking users

Use the REST API to manage blocked users.

About blocking users

If a request URL does not include a {username} parameter then the response will be for the signed-in user (and you must pass authentication information with your request). Additional private information, such as whether a user has two-factor authentication enabled, is included when authenticated through OAuth with the user scope.

List users blocked by the authenticated user

GET /user/blocks

List the users you've blocked on your personal account.

Parameters

Headers

• accept (string)
  Setting to application/vnd.github+json is recommended.

Path and query parameters

• per_page (integer)
  The number of results per page (max 100). For more information, see "Using pagination in the REST API."
  Default: 30

• page (integer)
  The page number of the results to fetch. For more information, see "Using pagination in the REST API."
  Default: 1

HTTP response status codes

• 200 - OK

• 304 - Not modified

• 401 - Requires authentication

• 403 - Forbidden

• 404 - Resource not found

Code examples

Example

Request:

curl -L \
  -X GET \
  https://api.github.com/user/blocks

Response schema (Status: 200):

Array of Simple User:

• name: string or null
• email: string or null
• login: required, string
• id: required, integer, format: int64
• node_id: required, string
• avatar_url: required, string, format: uri
• gravatar_id: required, string or null
• url: required, string, format: uri
• html_url: required, string, format: uri
• followers_url: required, string, format: uri
• following_url: required, string
• gists_url: required, string
• starred_url: required, string
• subscriptions_url: required, string, format: uri
• organizations_url: required, string, format: uri
• repos_url: required, string, format: uri
• events_url: required, string
• received_events_url: required, string, format: uri
• type: required, string
• site_admin: required, boolean
• starred_at: string
• user_view_type: string

Check if a user is blocked by the authenticated user

GET /user/blocks/{username}

Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.

Parameters

Headers

• accept (string)
  Setting to application/vnd.github+json is recommended.

Path and query parameters

• username (string) (required)
  The handle for the GitHub user account.

HTTP response status codes

• 204 - If the user is blocked

• 304 - Not modified

• 401 - Requires authentication

• 403 - Forbidden

• 404 - If the user is not blocked

Code examples

Example

Request:

curl -L \
  -X GET \
  https://api.github.com/user/blocks/USERNAME

Response schema (Status: 204):

Block a user

PUT /user/blocks/{username}

Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.

Parameters

Headers

• accept (string)
  Setting to application/vnd.github+json is recommended.

Path and query parameters

• username (string) (required)
  The handle for the GitHub user account.

HTTP response status codes

• 204 - No Content

• 304 - Not modified

• 401 - Requires authentication

• 403 - Forbidden

• 404 - Resource not found

• 422 - Validation failed, or the endpoint has been spammed.

Code examples

Example

Request:

curl -L \
  -X PUT \
  https://api.github.com/user/blocks/USERNAME

Response schema (Status: 204):

Unblock a user

DELETE /user/blocks/{username}

Unblocks the given user and returns a 204.

Parameters

Headers

• accept (string)
  Setting to application/vnd.github+json is recommended.

Path and query parameters

• username (string) (required)
  The handle for the GitHub user account.

HTTP response status codes

• 204 - No Content

• 304 - Not modified

• 401 - Requires authentication

• 403 - Forbidden

• 404 - Resource not found

Code examples

Example

Request:

curl -L \
  -X DELETE \
  https://api.github.com/user/blocks/USERNAME

Response schema (Status: 204):