Get fork PR contributor approval permissions for a repository

GET

/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval

Gets the fork PR contributor approval policy for a repository.

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

API method documentation

Parameters

Path Parameters

owner

required

string

The account owner of the repository. The name is not case sensitive.

repo

required

string

The name of the repository without the .git extension. The name is not case sensitive.

Responses

200

Response

Media type application/json

object

approval_policy

required

The policy that controls when fork PR workflows require approval from a maintainer.

string

Allowed values: first_time_contributors_new_to_github first_time_contributors all_external_contributors

Examples

Example default

{
  "approval_policy": "first_time_contributors"
}

404

Resource not found

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}