# The Organization object

> The account boundary that owns Workspaces and API keys.

Organization reads require a signed-in person's credentials. The active organization comes
from that authenticated context. API keys authorize memory requests and cannot administer
their owning organization.

Read an Organization or its membership with the operations below. Use `include=members` on
the detail read to load its initial membership page. Organization creation, naming and roster
management use the account and identity-provider flows described in [Organizations](https://augenta.pages.dev/docs/organizations.md).

## Available operations

* [GET `/v1/orgs` — List organizations](https://augenta.pages.dev/docs/api-reference/list-organizations.md)
* [GET `/v1/orgs/{id}` — Retrieve an organization](https://augenta.pages.dev/docs/api-reference/get-organization.md)
* [GET `/v1/orgs/{id}/members` — List organization members](https://augenta.pages.dev/docs/api-reference/list-organization-members.md)

## Attributes

These are response fields: always present can allow null; conditional fields can be omitted.

<a id="organization-object"></a>

### `organization.object`

`string` · always present

The resource type. Always organization.

Allowed values: `"organization"`.

<a id="organization-id"></a>

### `organization.id`

`string` · always present

Augenta Organization ID used in resource routes.

Min length: `1`.

<a id="organization-name"></a>

### `organization.name`

`string` · always present

Organization display name.

<a id="organization-role"></a>

### `organization.role`

`string` · conditional

The signed-in person's organization role, when loaded.

<a id="organization-workosorgid"></a>

### `organization.workosOrgId`

`string` · conditional

External identity-provider reference, when present. Resource routes use id instead.

<a id="organization-membercount"></a>

### `organization.memberCount`

`integer | null` · always present

Full roster count, or null when the roster has not been read.

Minimum: `0`.

<a id="organization-members"></a>

### `organization.members`

`object` · conditional

Initial membership page, loaded by include=members on the detail read. Follow its nextPageUrl for more.

<a id="organization-members-object"></a>

### `organization.members.object`

`string` · always present

Allowed values: `"list"`.

<a id="organization-members-url"></a>

### `organization.members.url`

`string` · always present

<a id="organization-members-data"></a>

### `organization.members.data`

`array<value>` · always present

<a id="organization-members-data-object"></a>

### `organization.members.data.object`

`string` · always present

Allowed values: `"organization_member"`, `"workspace_member"`.

<a id="organization-members-data-id"></a>

### `organization.members.data.id`

`string` · always present

Min length: `1`.

<a id="organization-members-data-userid"></a>

### `organization.members.data.userId`

`string` · always present

Min length: `1`.

<a id="organization-members-data-organization"></a>

### `organization.members.data.organization`

`string` · always present

<a id="organization-members-data-workspace"></a>

### `organization.members.data.workspace`

`string` · conditional

<a id="organization-members-data-name"></a>

### `organization.members.data.name`

`string` · conditional

<a id="organization-members-data-email"></a>

### `organization.members.data.email`

`string` · conditional

<a id="organization-members-data-role"></a>

### `organization.members.data.role`

`string` · conditional

<a id="organization-members-data-workspacerole"></a>

### `organization.members.data.workspaceRole`

`string` · conditional

<a id="organization-members-data-orgrole"></a>

### `organization.members.data.orgRole`

`string` · conditional

<a id="organization-members-data-via"></a>

### `organization.members.data.via`

`string` · conditional

<a id="organization-members-data-addedat"></a>

### `organization.members.data.addedAt`

`string` · conditional

<a id="organization-members-data-addedbyuserid"></a>

### `organization.members.data.addedByUserId`

`string` · conditional

<a id="organization-members-data-permissions"></a>

### `organization.members.data.permissions`

`array<string>` · conditional

<a id="organization-members-data-memberclass"></a>

### `organization.members.data.memberClass`

`string` · conditional

<a id="organization-members-data-hassignedin"></a>

### `organization.members.data.hasSignedIn`

`boolean` · conditional

<a id="organization-members-data-joinedat"></a>

### `organization.members.data.joinedAt`

`string` · conditional

<a id="organization-members-nextpageurl"></a>

### `organization.members.nextPageUrl`

`string | null` · always present

## Example object

```json
{
  "object": "organization",
  "id": "org_example",
  "name": "Example",
  "memberCount": 2,
  "role": "Owner"
}
```
