# List or read organizations

URL: https://heaven.dev/docs/reference/organizations/view
Updated: 2026-11-21

List the organizations you belong to and your role in each. Supply `organization` to read one organization's settings, members and teams.

`GET /v1/organization/`

## Parameters

- `organization` (string): Organization name or ID. Omit to list your organizations.

## Returns

- `data` (object[] | object, always present): Your organizations and roles, or one organization's membership, teams and settings.
  - `alternative-1` (object[]): An organization you belong to and your permissions in it.
    - `items` (object): An organization you belong to and your permissions in it.
      - `display_name` (string): Its display name, when different from its command name. May be omitted.
      - `grant_scope` (string): Resources reached by the additional command grants. May be omitted.
      - `grants` (string[]): Commands granted beyond your role. May be omitted.
      - `id` (string, always present): Organization ID.
      - `name` (string, always present): Organization name accepted by commands.
      - `picture` (string): Organization's picture URL. May be omitted.
      - `role` (string, always present): Your role in this organization.
      - `withholds` (string[]): Commands withheld even though your role would otherwise allow them. May be omitted.
  - `alternative-2` (object): An organization's settings, members, teams and your permissions.
    - `closing_at` (string (date-time)): When a scheduled organization closure takes effect. May be omitted.
    - `computer_sharing` (string, always present): Organization's policy for sharing Computers.
    - `computers` (integer, always present): Organization's Computer count.
    - `grant_scope` (string): Resources reached by additional command grants. May be omitted.
    - `grants` (string[]): Commands granted beyond your role. May be omitted.
    - `id` (string, always present): Organization ID.
    - `invitations` (object[]): Pending invitations, visible to the billing owner and admins. May be omitted.
      - `items` (object): An unanswered invitation sent by the organization or one of its teams.
        - `email` (string, always present): Invited email, or user ID when invited by ID without email.
        - `expires_at` (string (date-time), always present): When the invitation expires.
        - `grant_scope` (string): Resources reached by the offered grants. May be omitted.
        - `grants` (string[]): Additional commands offered. May be omitted.
        - `id` (string, always present): Invitation ID.
        - `invited_by` (string, always present): Who sent the invitation.
        - `role` (string, always present): Offered organization role.
        - `team` (string): Team sending a team invitation. May be omitted.
        - `team_role` (string): Offered team role. May be omitted.
        - `teams` (string[]): Teams included in the invitation. May be omitted.
        - `withholds` (string[]): Commands withheld from the offered role. May be omitted.
    - `members` (object[] | null, always present): Organization's members and permissions.
      - `items` (object): An organization member and their permissions.
        - `email` (string | null, always present): Their email address, or null without one.
        - `grant_scope` (string): Resources reached by additional command grants. May be omitted.
        - `grants` (string[]): Commands granted beyond the role. May be omitted.
        - `name` (string): Their saved display name, when available. May be omitted.
        - `picture` (string): Their profile picture URL. May be omitted.
        - `role` (string, always present): Their organization role.
        - `teams` (string[] | null, always present): Teams this person belongs to.
        - `user_id` (string, always present): Member's user ID.
        - `withholds` (string[]): Commands withheld from the role. May be omitted.
    - `name` (string, always present): Organization's command name.
    - `outsider_invitations` (string, always present): Who can invite outsiders: `team-admins` or `admins-only`.
    - `picture` (string): Organization's picture URL. May be omitted.
    - `role` (string, always present): Your organization role.
    - `teams` (object[] | null, always present): Organization's teams.
      - `items` (object): An organization team, its members, owned Computers and shared access.
        - `computers` (string[] | null, always present): Computers owned by the team.
        - `full_name` (string, always present): Team name qualified by its organization.
        - `id` (string, always present): Team ID.
        - `member_access` (string, always present): Access team members receive to Computers the team owns.
        - `members` (object[] | null, always present): Team's members and their team roles.
          - `items` (object): A person's membership in an organization team.
            - `email` (string | null, always present): Their email address, or null without one.
            - `name` (string): Their display name, when set. May be omitted.
            - `picture` (string): Their profile picture URL. May be omitted.
            - `role` (string, always present): Their role within this team.
            - `user_id` (string, always present): Person's user ID.
        - `name` (string, always present): Team's name within its organization.
        - `pools` (object[] | null, always present): Pools shared with the team by other accounts.
          - `items` (object): A pool another account shares with the team.
            - `account` (string, always present): Account providing the pool.
            - `commands` (string[]): Additional commands the share grants. May be omitted.
            - `pool` (string, always present): Shared pool's name.
            - `pool_id` (string, always present): Shared pool's ID.
            - `role` (string, always present): Pool share's role.
        - `shares` (object[] | null, always present): Computer access granted to the team.
          - `items` (object): Access to a Computer shared with a team.
            - `commands` (string[]): Additional commands granted to the team. May be omitted.
            - `computer` (string, always present): Shared Computer's name.
            - `role` (string, always present): Share's access role.
    - `withheld` (string[]): Parts your permissions do not allow you to read. May be omitted.
    - `withholds` (string[]): Commands withheld from your role. May be omitted.

## Errors

Each code is explained in full at https://heaven.dev/docs/reference/errors.

| Code | Status | What happened |
|---|---:|---|
| `invalid` | 400 | An input is missing or invalid. |
| `unauthenticated` | 401 | The credential is missing, invalid, expired or revoked. |
| `denied` | 403 | The caller lacks permission for this action. |
| `not_found` | 404 | The resource is absent or inaccessible to this caller. |
| `conflict` | 409 | The request conflicts with the current resource state or an earlier request. |
| `over_capacity` | 409 | The request exceeds a resource or credential allowance. |
| `access_list_full` | 409 | The change would exceed the access-list allowance. |
| `rate_limited` | 429 | The caller's request rate exceeds its limit. |
| `busy` | 429 | Too much work is in progress to accept this request. |
| `unknown` | 503 | The outcome is unconfirmed; a change may have happened. |
| `unavailable` | 503 | The service or requested feature is unavailable. |

## Notes

- API key permission: `organization view`.

## Examples

```sh tab="heaven CLI"
heaven organization view
  [--organization ORGANIZATION]
```

```sh tab="SSH"
ssh cli@heaven.dev organization view
  [--organization ORGANIZATION]
```

```sh tab="cURL"
curl "https://heaven.dev/v1/organization/?organization=acme" \
  -H "Authorization: Bearer $HEAVEN_API_KEY"
```

```json tab="MCP"
{ "tool": "organization_view",
  "arguments": { "organization": "acme" } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "computer_sharing": "all-members",
    "computers": 2,
    "id": "52f5ec43-1904-46e6-acf3-6a9c9cd70901",
    "members": [
      {
        "email": "you@example.com",
        "role": "billing_owner",
        "teams": [],
        "user_id": "27deda0c-0547-4365-a33d-e105e42401ec"
      }
    ],
    "name": "acme",
    "outsider_invitations": "team-admins",
    "role": "billing_owner",
    "teams": []
  }
}
```
