Check whether a user can be assigned to an issue | GitHub API (unofficial showcase)

4 parameters

ownerstringrequired

The account that owns the repository; the name is not case-sensitive.

repostringrequired

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

issue_numberintegerrequired

The number that identifies the issue to check.

assigneestringrequired

The username of the user whose assignment eligibility you want to check.

2 status codes

204Returns no response body when the user can be assigned to the issue.

404Returned when the user cannot be assigned to the issue.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned when assignee cannot be assigned to the issue identified by issue_number in the specified repository.

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

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

const result = await client.assignees.get({
  owner: "octocat",
  repo: "hello-world",
  issueNumber: "example",
  assignee: "example",
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors