Retrieve an organization
/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
Responses
Organization resource, optionally including membership.
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