Get a database – GET /v1/databases/{databaseId}

GET/v1/databases/{databaseId}

betaapiKeyworkspace

When to use

Read the current status of one managed database.

For agents

Use after create while status is provisioning, or to confirm a database is ready before writing tables.

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.get('dbas_crm123');

Response

json

{
  "data": {
    "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"
  }
}