Skip to content
AugentaDocsOpen console ↗
Organizations

Documentation

API reference
View Markdown

Organizations

Read organizations and their membership with a person's credentials.

An Organization owns Workspaces and API keys. Administration requests use a signed-in person's session or Bearer access token. An API key cannot administer its organization. The active organization comes from that authenticated context; request bodies cannot choose another tenant.

See the Organization object for its available operations, all attributes and an example object.

Endpoints

EndpointPurpose
GET /v1/orgsList organizations the person can access.
GET /v1/orgs/{id}Retrieve the active organization, optionally including membership.
GET /v1/orgs/{id}/membersPage through its organization roster.

There is no direct Organization create, rename or delete resource operation. Organization names and organization membership are managed through the identity provider. The console's PUT /v1/me/active-org operation switches session context; its result is an acknowledgment or a browser authorization redirect, rather than an Organization resource.

Organization fields

FieldMeaning
objectAlways organization.
idAugenta Organization ID. Use it in resource routes.
nameOrganization display name.
roleThe signed-in person's organization role, when loaded.
memberCountFull roster count, or null when it has not been read.
workosOrgIdOptional external identity-provider reference; it is not the resource ID.
membersInitial membership list page, present when requested with include=members.

Organization list pages also contain activeOrgId and personalOrgPolicy: "visible". Personal organizations remain available after someone joins a team, so their data stays reachable. Lists use live keyset pagination and recheck access on every page; they are not frozen membership snapshots. Follow nextPageUrl unchanged. See Pagination.

Retrieve an organization

bash
curl --fail-with-body -sS --get "https://api.augenta.ai/v1/orgs/$AUGENTA_ORG_ID" \
  -H "Authorization: Bearer $AUGENTA_ACCESS_TOKEN" \
  --data-urlencode "include=members"
json
{
  "object": "organization",
  "id": "aug-example",
  "name": "Example",
  "role": "owner",
  "memberCount": 1,
  "members": {
    "object": "list",
    "url": "/v1/orgs/aug-example/members",
    "data": [{
      "object": "organization_member",
      "id": "user-example",
      "userId": "user-example",
      "organization": "aug-example",
      "name": "Example User",
      "role": "owner",
      "hasSignedIn": true
    }],
    "nextPageUrl": null
  }
}

A membership's id is its userId within the parent organization. A provisioned person may appear with hasSignedIn: false. The roster uses the identity provider when available, with local membership as its fallback. Neither an empty page nor a local fallback proves a person was deleted from the external directory.