Orgs

Interact with organizations.

Operations

MethodEndpointDescription
GET/organizationsList organizations
GET/orgs/{org}Get an organization
PATCH/orgs/{org}Update an organization
DELETE/orgs/{org}Delete an organization
POST/orgs/{org}/artifacts/metadata/deployment-recordCreate an artifact deployment record
POST/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}Set cluster deployment records
POST/orgs/{org}/artifacts/metadata/storage-recordCreate artifact metadata storage record
GET/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-recordsList artifact deployment records
GET/orgs/{org}/artifacts/{subject_digest}/metadata/storage-recordsList artifact storage records
POST/orgs/{org}/attestations/bulk-listList attestations by bulk subject digests
POST/orgs/{org}/attestations/delete-requestDelete attestations in bulk
DELETE/orgs/{org}/attestations/digest/{subject_digest}Delete attestations by subject digest
GET/orgs/{org}/attestations/repositoriesList attestation repositories
DELETE/orgs/{org}/attestations/{attestation_id}Delete attestations by ID
GET/orgs/{org}/attestations/{subject_digest}List attestations
GET/orgs/{org}/blocksList users blocked by an organization
GET/orgs/{org}/blocks/{username}Check if a user is blocked by an organization
PUT/orgs/{org}/blocks/{username}Block a user from an organization
DELETE/orgs/{org}/blocks/{username}Unblock a user from an organization
GET/orgs/{org}/failed_invitationsList failed organization invitations
GET/orgs/{org}/hooksList organization webhooks
POST/orgs/{org}/hooksCreate an organization webhook
GET/orgs/{org}/hooks/{hook_id}Get an organization webhook
PATCH/orgs/{org}/hooks/{hook_id}Update an organization webhook
DELETE/orgs/{org}/hooks/{hook_id}Delete an organization webhook
GET/orgs/{org}/hooks/{hook_id}/configGet a webhook configuration for an organization
PATCH/orgs/{org}/hooks/{hook_id}/configUpdate a webhook configuration for an organization
GET/orgs/{org}/hooks/{hook_id}/deliveriesList deliveries for an organization webhook
GET/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}Get a webhook delivery for an organization webhook
POST/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attemptsRedeliver a delivery for an organization webhook
POST/orgs/{org}/hooks/{hook_id}/pingsPing an organization webhook
GET/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}Get route stats by actor
GET/orgs/{org}/insights/api/subject-statsGet subject stats
GET/orgs/{org}/insights/api/summary-statsGet summary stats
GET/orgs/{org}/insights/api/summary-stats/users/{user_id}Get summary stats by user
GET/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}Get summary stats by actor
GET/orgs/{org}/insights/api/time-statsGet time stats
GET/orgs/{org}/insights/api/time-stats/users/{user_id}Get time stats by user
GET/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}Get time stats by actor
GET/orgs/{org}/insights/api/user-stats/{user_id}Get user stats

The full set of 108 operations is in the API reference.

Example

List organizations, with the TypeScript SDK:

ts
import { GitHubV3REST } from "github";

const client = new GitHubV3REST({
  baseUrl: "https://api.github.com",
});

const result = await client.orgs.list();
console.log(result);
Nine more languages

The same call exists in every SDK. See SDKs for the other nine.