Retrieve an organization

client.orgs.retrieve(, ?): Org { display_name, enable_ai_commit_messages, object, slug }

GET/v0/orgs/{org}

Retrieve an organization by name.

ParametersExpand Collapse

org: string

ReturnsExpand Collapse

Org { display_name, enable_ai_commit_messages, object, slug }

display_name: string | null

enable_ai_commit_messages: boolean

object: "org"

slug: string

Retrieve an organization

import Stainless from '@stainless-api/sdk';

const client = new Stainless({
  apiKey: process.env['STAINLESS_API_KEY'], // This is the default and can be omitted
});

const org = await client.orgs.retrieve('org');

console.log(org.display_name);

{
  "display_name": "display_name",
  "enable_ai_commit_messages": true,
  "object": "org",
  "slug": "slug"
}

Returns Examples

{
  "display_name": "display_name",
  "enable_ai_commit_messages": true,
  "object": "org",
  "slug": "slug"
}