Get fork PR contributor approval permissions for a repository

2 parameters

ownerstringrequired

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

repostringrequired

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

2 status codes

200Response

approval_policystringrequired

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

Allowed:first_time_contributors_new_to_githubfirst_time_contributorsall_external_contributors

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned: Resource not found.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.forkPrContributorApproval.list({
  owner: "octocat",
  repo: "hello-world",
});

{
  "approval_policy": "first_time_contributors"
}

Request

Response

Errors