Get interaction restrictions for an organization

1 parameter

orgstringrequired

The organization name. The name is not case sensitive.

1 status code

200Response

limitstringrequired

The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.

Allowed:existing_userscontributors_onlycollaborators_only

originstringrequired

expires_atstringrequired

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.interactionLimits.list({ org: "acme-inc" });

{
  "limit": "collaborators_only",
  "origin": "organization",
  "expires_at": "2018-08-17T04:18:39Z"
}