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
The Organization object
Attributes
These are response fields. “Always present” can still allow null; “conditional” means the field can be omitted.
namestringalways presentOrganization display name.
rolestringconditionalThe signed-in person's organization role, when loaded.
workosOrgIdstringconditionalExternal identity-provider reference, when present. Resource routes use id instead.
memberCountinteger | nullalways presentFull roster count, or null when the roster has not been read.
Minimum: 0
membersobjectconditionalInitial membership page, loaded by include=members on the detail read. Follow its nextPageUrl for more.
Show nested fields
objectstringalways presentAllowed: "list"
urlstringalways presentdataarrayalways presentShow item fields
objectstringalways presentAllowed: "organization_member""workspace_member"
idstringalways presentMin length: 1
userIdstringalways presentMin length: 1
organizationstringalways presentworkspacestringconditionalnamestringconditionalemailstringconditionalrolestringconditionalworkspaceRolestringconditionalorgRolestringconditionalviastringconditionaladdedAtstringconditionaladdedByUserIdstringconditionalpermissionsarrayconditionalShow item fields
memberClassstringconditionalhasSignedInbooleanconditionaljoinedAtstringconditionalnextPageUrlstring | nullalways present