> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Orgs

> Read an organization's display name and the email domains whose users join it automatically when they sign in, and update its display name.

## Schema introspection

Every command below with arguments supports two read-only flags for tooling and AI agents:

* `--show-file-schema`: print the JSON Schema for the full request object (the format `--filename` accepts).
* `--show-argument-schema <flag-name>`: print the JSON Schema for one argument's value. Pass the kebab flag name **without** the leading `--` (e.g. `org-id`, not `--org-id`).

Both write pure JSON to stdout and never call the API. They cannot be combined with any other command-specific flag.

## `get`

Get an organization

Retrieve an organization's display name and email domains. The organization is identified by
the `org_id` path parameter alone; the `x-hh-org-id` header does not participate. Your
organization's id is listed on the API keys page of your organization settings in the
HoneyHive app.

### Usage

```sh theme={null}
honeyhive orgs get [options]
```

**Accepted keys:** [Control plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

### Options

| Flag | Type | Required | Description |
| - | - | - | - |
| `--org-id` | string | yes | The unique identifier of the organization to retrieve |

Also supports `--show-file-schema`, `--show-argument-schema <flag-name>`, and `--filename`. See [Schema introspection](#schema-introspection) for details.

## `update`

Update an organization

Update an organization's display name. The organization is identified by the `org_id` path
parameter alone; the `x-hh-org-id` header does not participate.

The organization's email domains cannot be changed through the API. Set them in the
organization settings of the HoneyHive app.

### Usage

```sh theme={null}
honeyhive orgs update [options]
```

**Accepted keys:** [Control plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

### Options

| Flag | Type | Required | Description |
| - | - | - | - |
| `--org-id` | string | yes | The unique identifier of the organization to update |
| `--name` | string | no | Organization display name. Allowed characters are the letters A-Z and a-z (no accented letters), digits, space, underscore, hyphen, apostrophe and ampersand, and the name must not start with a space. |

Also supports `--show-file-schema`, `--show-argument-schema <flag-name>`, and `--filename`. See [Schema introspection](#schema-introspection) for details.


## Related topics

- [Orgs Methods](https://docs.honeyhive.ai/v2/control-plane-sdk-reference/typescript/ref/orgs/index.md)
- [Org Members](https://docs.honeyhive.ai/v2/cli-reference/ref/org-members.md)
- [Org Templates](https://docs.honeyhive.ai/v2/cli-reference/ref/org-templates.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.