Organizations · organizationsList

List organizations

Lists organizations the signed-in user owns or belongs to. A CLI login lists only the organization approved for that login. An account-level session can identify an organization that requires another sign-in via signInRequired.

GET/v1/organizations

betaplatformUsernone

When to use

Find the organization ID to use in organization URLs.

For agents

A CLI login returns its approved organization. With an account-level session, signInRequired identifies organizations that need a fresh sign-in.

Example

typescript

import { OAuthLogin } from '@permute/sdk/auth';

const client = await new OAuthLogin().client();
const result = await client.organizations.list();

Response

json

{
  "data": {
    "items": [
      {
        "id": "org_acme123",
        "name": "Acme",
        "signInRequired": null
      }
    ]
  }
}