PermuteDocs
Go to Permute

Databases · databasesList

List databases

List managed databases in the current workspace.

GET/v1/databases
betaapiKeyworkspace

When to use

List managed databases in the current workspace.

For agents

Creation is limited to entitled Enterprise plans. Existing databases remain listed when creation is unavailable.

Example

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

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

const client = orgClient.withWorkspace(process.env.PERMUTE_WORKSPACE_ID!);

const result = await client.databases.list();

Response

json
{
  "data": {
    "items": [
      {
        "id": "dbas_crm123",
        "workspaceId": "wksp_finance123",
        "name": "CRM",
        "key": "crm",
        "status": "ready",
        "createdAt": "2026-09-18T12:00:00.000Z",
        "updatedAt": "2026-09-18T12:00:08.000Z"
      }
    ]
  }
}