Skip to content
AugentaDocsOpen console ↗
List organizations

Documentation

API reference
View Markdown

List organizations

GET/v1/orgs

Organizations the signed-in person can access. Personal organizations remain visible. The active organization is returned separately as activeOrgId.

Authentication

Use your signed-in console session or a person's WorkOS access token for this setup operation. See authentication and permissions.

Request

Parameters

limitintegeroptional

query parameter.

Minimum: 1Maximum: 200

Default: 50

pagestringoptional

query parameter.

Min length: 1Max length: 4096

Responses

One bounded resource page. Follow nextPageUrl unchanged; the authenticated page retains caller, active organization, filters and limit. Access is rechecked on every request. Administration lists use live keyset reads and may change between pages.

objectstringalways present

Allowed: "list"

urlstringalways present
dataarrayalways present
Show item fields
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

See the complete schema in the OpenAPI specification.

memberClassstringconditional
hasSignedInbooleanconditional
joinedAtstringconditional
nextPageUrlstring | nullalways present
nextPageUrlstring | nullalways present
activeOrgIdstringalways present
personalOrgPolicystringalways present

Allowed: "visible"