Skip to content
AugentaDocsOpen console ↗
The Organization object

Documentation

API reference
View Markdown

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.

Available operations

Usage and lifecycle →

The Organization object

Attributes

These are response fields. “Always present” can still allow null; “conditional” means the field can be omitted.

objectstringalways present

The resource type. Always organization.

Allowed: "organization"

idstringalways present

Augenta Organization ID used in resource routes.

Min length: 1

namestringalways present

Organization display name.

rolestringconditional

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

workosOrgIdstringconditional

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

memberCountinteger | nullalways present

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

Minimum: 0

membersobjectconditional

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

Show nested fields
objectstringalways present

Allowed: "list"

urlstringalways present
dataarrayalways present
Show item fields
objectstringalways present

Allowed: "organization_member""workspace_member"

idstringalways present

Min length: 1

userIdstringalways present

Min length: 1

organizationstringalways present
workspacestringconditional
namestringconditional
emailstringconditional
rolestringconditional
workspaceRolestringconditional
orgRolestringconditional
viastringconditional
addedAtstringconditional
addedByUserIdstringconditional
permissionsarrayconditional
Show item fields
memberClassstringconditional
hasSignedInbooleanconditional
joinedAtstringconditional
nextPageUrlstring | nullalways present