PermuteDocs
Go to Permute

Facts · factsList

List organization facts

Reads shared business definitions, aliases, formulas, and baselines. Requires organization-wide fact read permission.

GET/v1/facts
betaapiKeyorganization

When to use

Discover canonical business definitions and calculations.

For agents

Facts apply across the organization. This requires organization-wide fact read permission.

Example

typescript
import { PermuteClient } from '@permute/sdk';

const orgClient = new PermuteClient({
  apiKey: process.env.PERMUTE_API_KEY!,
});

const result = await orgClient.facts.list();

Response

json
{
  "data": {
    "items": [
      {
        "id": "fact_revenue123",
        "organizationId": "org_acme123",
        "ownerId": "user_admin123",
        "key": "net_revenue",
        "name": "Net revenue",
        "type": "formula",
        "definition": "Revenue after returns",
        "formula": "revenue - returns",
        "formulaType": "math",
        "aliases": null,
        "usualValue": null,
        "usualValueMin": null,
        "usualValueMax": null,
        "unit": null,
        "startDate": null,
        "endDate": null,
        "scope": null,
        "metadata": null,
        "createdAt": "2026-09-10T12:00:00.000Z",
        "updatedAt": "2026-09-10T12:00:00.000Z"
      }
    ]
  }
}