PermuteDocs
Go to Permute

Write syncs · writeSyncsGetRun

Inspect write sync results

Returns one zero-based page of captured values and per-record outcomes. Poll until previewComplete or an error; inspect all pageCount pages before approval. A completed execution may contain rejected or blocked records; check record statuses. Unconfirmed writes are never blindly resent.

GET/v1/write-syncs/{writeSyncId}/runs/{runId}
betaapiKeyworkspace

When to use

Review captured values and per-record outcomes on one zero-based page.

For agents

Read all pageCount pages after preview completion. After delivery, inspect statuses even when execution.completedAt is set: blocked, rejected or unknown records require attention. Unknown writes are never blindly resent.

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.writeSyncs.getRun('wsyn_contacts123', 'wsrn_abcdefghijklmnopqrstuvwx', { page: 0 });

Response

json
{
  "data": {
    "id": "wsrn_abcdefghijklmnopqrstuvwx",
    "writeSyncId": "wsyn_contacts123",
    "definitionVersion": 1,
    "definitionRevisionId": "rvsn_sync123",
    "sourceOperation": {
      "runId": "oprn_contacts123",
      "revisionId": "rvsn_contacts123"
    },
    "previewComplete": true,
    "recordCount": 1,
    "page": 0,
    "pageCount": 1,
    "records": [
      {
        "key": "ada@example.com",
        "values": {
          "emails": "ada@example.com",
          "firstName": "Ada",
          "lastName": "Lovelace"
        },
        "action": "create",
        "status": "pending"
      }
    ]
  }
}