Databases · databaseRecordsList

Read database records

Reads a table in the requested schema (app by default). Managed tables include opaque __version tokens; imported tables may not. Pagination reflects current data, not a historical snapshot; tables without primary keys have no guaranteed row order.

GET/v1/databases/{databaseId}/tables/{table}/records

betaapiKeyworkspace

When to use

Read current rows from one table.

For agents

Defaults to the app schema. Managed tables include opaque __version tokens needed for later updates. Pagination is not a historical snapshot.

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.records('dbas_crm123', 'customers', { limit: 25 });

Response

json

{
  "data": {
    "items": [
      {
        "id": "acme",
        "name": "Acme",
        "__version": "11111111-1111-4111-8111-111111111111"
      }
    ]
  }
}