PermuteDocs
Go to Permute

Organizations · organizationsGet

Get an organization

Reads basic organization information with a session authorized for that organization. A workspace-bound CLI login can read its parent organization.

GET/v1/organizations/{organizationId}
betaplatformUsernone

When to use

Look up the name of an organization by its ID.

For agents

Use a platform user or CLI login authorized for this organization. The URL supplies the ID.

Example

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

const client = await new OAuthLogin().client();
const result = await client.organizations.get('org_acme123');

Response

json
{
  "data": {
    "id": "org_acme123",
    "name": "Acme",
    "signInRequired": null
  }
}