API Reference

Orgs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve an organization

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

get/v0/orgs/{org}

Retrieve an organization by name.

ParametersExpand Collapse

org: string

ReturnsExpand Collapse

Org { display_name, object, slug }

display_name: string | null

object: "org"

Accepts one of the following:

"org"

slug: string

Retrieve an organization

TypeScript

HTTP

TypeScript

Python

Java

Go

IMPORT STAINLESS FROM '@STAINLESS-API/SDK';

CONST CLIENT = NEW STAINLESS({
  APIKEY: 'MY API KEY',
});

CONST ORG = AWAIT CLIENT.ORGS.RETRIEVE('ORG');

CONSOLE.LOG(ORG.DISPLAY_NAME);

200 example

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

Returns Examples

200 example

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