Get default workflow permissions for a repository | GitHub API (unofficial showcase)

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.

1 status code

200Response

default_workflow_permissionsstringrequired

The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

Allowed:readwrite

can_approve_pull_request_reviewsbooleanrequired

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
});

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

{
  "default_workflow_permissions": "read",
  "can_approve_pull_request_reviews": true
}

Request

Response