Get Organization

Gets detailed information about an organization

Usage #

// Import the typed helper
import { getOrg } from "@hotglue/sdk/github";
const result = await client.execute({
...getOrg({
org: string,
}),
userId: "user_123",
});
// result is typed as GetOrgOutput
const result = await client.execute({
integration: "github",
tool: "get_org",
userId: "user_123",
input: {
org: string,
},
});
// The agent will automatically use this tool when needed
const agent = new Agent({
tools: () => hotglueTools({
integrations: ["github"],
userId: "user_123",
}),
});
await agent.generate("run the Get Organization tool");

Required Permissions #

read:org

Input Schema #

org string required

Organization name

Output Schema #

id int required
login string required
name string
description string
html_url string required
avatar_url string
public_repos int
public_gists int
followers int
following int
created_at string
updated_at string

This tool calls: #

GET https://api.github.com/orgs/{org}