Check if a user is blocked by an organization

2 parameters

orgstringrequired

The organization name. The name is not case sensitive.

usernamestringrequired

The handle for the GitHub user account.

2 status codes

204If the user is blocked

404If the user is not blocked

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned: If the user is not blocked.

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.blocks.get({
  org: "acme-inc",
  username: "octocat",
});

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

Request

Response

Errors