Blocking users

The token used to authenticate the call must have the admin:org scope in order to make any blocking calls for an organization. Otherwise, the response returns HTTP 404.

List users blocked by an organization

List the users blocked by an organization.

get /orgs/{org}/blocks

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`org`	string	path

Code samples

Example

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/orgs/ORG/blocks

JavaScript @octokit/core.js

await octokit.request('GET /orgs/{org}/blocks', {
  org: 'ORG'
})

GitHub CLI gh api

gh api \
  -H "Accept: application/vnd.github.v3+json" \
  /orgs/ORG/blocks

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

Status codes

HTTP Status Code	Description
`200`	OK

Notes

Works with GitHub Apps

Check if a user is blocked by an organization

get /orgs/{org}/blocks/{username}

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`org`	string	path
`username`	string	path

Code samples

Example

Shell

curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/orgs/ORG/blocks/USERNAME

JavaScript @octokit/core.js

await octokit.request('GET /orgs/{org}/blocks/{username}', {
  org: 'ORG',
  username: 'USERNAME'
})

GitHub CLI gh api

gh api \
  -H "Accept: application/vnd.github.v3+json" \
  /orgs/ORG/blocks/USERNAME

If the user is blocked:

Status: 204

Status codes

HTTP Status Code	Description
`204`	If the user is blocked:
`404`	If the user is not blocked:

Notes

Works with GitHub Apps

Block a user from an organization

put /orgs/{org}/blocks/{username}

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`org`	string	path
`username`	string	path

Code samples

Example

Shell

curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/orgs/ORG/blocks/USERNAME

JavaScript @octokit/core.js

await octokit.request('PUT /orgs/{org}/blocks/{username}', {
  org: 'ORG',
  username: 'USERNAME'
})

GitHub CLI gh api

gh api \
  --method PUT \
  -H "Accept: application/vnd.github.v3+json" \
  /orgs/ORG/blocks/USERNAME

Response

Status: 204

Status codes

HTTP Status Code	Description
`204`	No Content
`422`	Validation failed

Notes

Works with GitHub Apps

Unblock a user from an organization

delete /orgs/{org}/blocks/{username}

Parameters

Name	Type	In	Description
`accept`	string	header	Setting to`application/vnd.github.v3+json` is recommended.
`org`	string	path
`username`	string	path

Code samples

Example

Shell

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/orgs/ORG/blocks/USERNAME

JavaScript @octokit/core.js

await octokit.request('DELETE /orgs/{org}/blocks/{username}', {
  org: 'ORG',
  username: 'USERNAME'
})

GitHub CLI gh api

gh api \
  --method DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  /orgs/ORG/blocks/USERNAME

Response

Status: 204

Status codes

HTTP Status Code	Description
`204`	No Content

Notes

Works with GitHub Apps