User interactions
The User interactions API allows you to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories.
About the User interactions API
The User interactions API allows you to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories. When restrictions are enabled, only the specified type of GitHub user will be able to participate in interactions. Restrictions automatically expire after a defined duration. Here's more about the types of GitHub users:
- Existing users: When you limit interactions to
existing_users, new users with accounts less than 24 hours old who have not previously contributed and are not collaborators will be temporarily restricted from interacting with your repositories. - Contributors only: When you limit interactions to
contributors_only, users who have not previously contributed and are not collaborators will be temporarily restricted from interacting with your repositories. - Collaborators only: When you limit interactions to
collaborators_only, users who are not collaborators will be temporarily restricted from interacting with your repositories.
Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. To set different interaction limits for individual repositories owned by the user, use the Repository interactions endpoints instead.
Get interaction restrictions for your public repositories
Shows which type of GitHub user can interact with your public repositories and when the restriction expires.
HTTP response status codes
| Status code | Description |
|---|---|
200 | Default response |
204 | Response when there are no restrictions |
Code samples
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://api.github.com/user/interaction-limitsDefault response