Skip to content
AugentaDocsOpen console ↗
Retrieve an organization

Documentation

API reference
View Markdown

Retrieve an organization

GET/v1/orgs/{id}

Select the active organization from the signed-in session. include=members adds its initial membership page. Organization names and organization membership are managed through the identity provider.

Authentication

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

Request

Parameters

idstringrequired

path parameter.

Min length: 1

includearrayoptional

query parameter.

Max items: 1

Show item fields

Allowed: "members"

Responses

Organization resource, optionally including membership.

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