← All tags

Interactions API Reference

Owner or admin management of users interactions.

12 endpoints tagged interactions, each listing its parameters and possible responses. Search or scroll the index below to jump to a specific endpoint.

No endpoints match your search.

Get interaction restrictions for an organization

GET /orgs/{org}/interaction-limits

Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	Response	yes

Set interaction restrictions for an organization

PUT /orgs/{org}/interaction-limits

Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	Response	yes
422	Validation failed, or the endpoint has been spammed.	yes

Remove interaction restrictions for an organization

DELETE /orgs/{org}/interaction-limits

Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
204	Response	no

Get interaction restrictions for a repository

GET /repos/{owner}/{repo}/interaction-limits

Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	Response	yes

Set interaction restrictions for a repository

PUT /repos/{owner}/{repo}/interaction-limits

Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	Response	yes
409	Response	no

Remove interaction restrictions for a repository

DELETE /repos/{owner}/{repo}/interaction-limits

Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
204	Response	no
409	Response	no

Get pull request creation cap bypass list for a repository

GET /repos/{owner}/{repo}/interaction-limits/pulls/bypass-list

Lists the users that are on the pull request creation cap bypass list for a

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	Response	yes
403	Forbidden	yes
404	Resource not found	yes

Add users to the pull request creation cap bypass list for a repository

PUT /repos/{owner}/{repo}/interaction-limits/pulls/bypass-list

Adds users to the pull request creation cap bypass list for a repository.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
204	Response	no
403	Forbidden	yes
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes

Remove users from the pull request creation cap bypass list for a repository

DELETE /repos/{owner}/{repo}/interaction-limits/pulls/bypass-list

Removes users from the pull request creation cap bypass list for a repository.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
204	Response	no
403	Forbidden	yes
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes

Get interaction restrictions for your public repositories

GET /user/interaction-limits

Shows which type of GitHub user can interact with your public repositories and when the restriction expires.

Parameters

No parameters.

Responses

Status	Description	Has JSON body
200	Default response	yes
204	Response when there are no restrictions	no

Set interaction restrictions for your public repositories

PUT /user/interaction-limits

Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.

Parameters

No parameters.

Responses

Status	Description	Has JSON body
200	Response	yes
422	Validation failed, or the endpoint has been spammed.	yes

Remove interaction restrictions from your public repositories

DELETE /user/interaction-limits

Removes any interaction restrictions from your public repositories.

Parameters

No parameters.

Responses

Status	Description	Has JSON body
204	Response	no