# Orgs

## List organizations

`client.orgs.list(RequestOptionsoptions?): OrgListResponse`

**get** `/v0/orgs`

List organizations accessible to the current authentication method.

### Returns

- `OrgListResponse`

  - `data: Array<Org>`

    - `display_name: string | null`

    - `enable_ai_commit_messages: boolean`

    - `object: "org"`

      - `"org"`

    - `slug: string`

  - `has_more: boolean`

  - `next_cursor?: string`

### Example

```typescript
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 orgs = await client.orgs.list();

console.log(orgs.data);
```

#### Response

```json
{
  "data": [
    {
      "display_name": "display_name",
      "enable_ai_commit_messages": true,
      "object": "org",
      "slug": "slug"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}
```

## Retrieve an organization

`client.orgs.retrieve(stringorg, RequestOptionsoptions?): Org`

**get** `/v0/orgs/{org}`

Retrieve an organization by name.

### Parameters

- `org: string`

### Returns

- `Org`

  - `display_name: string | null`

  - `enable_ai_commit_messages: boolean`

  - `object: "org"`

    - `"org"`

  - `slug: string`

### Example

```typescript
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);
```

#### Response

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

## Domain Types

### Org

- `Org`

  - `display_name: string | null`

  - `enable_ai_commit_messages: boolean`

  - `object: "org"`

    - `"org"`

  - `slug: string`

### Org List Response

- `OrgListResponse`

  - `data: Array<Org>`

    - `display_name: string | null`

    - `enable_ai_commit_messages: boolean`

    - `object: "org"`

      - `"org"`

    - `slug: string`

  - `has_more: boolean`

  - `next_cursor?: string`