Connector sessions · connectorSessionsGet

Get hosted connector session status

Only the issuing API key can retrieve the session. Completed means credentials were authorized or submitted and sync was queued; inspect the source separately for data readiness.

GET/v1/connector-sessions/{sessionId}

betaapiKeyworkspace

When to use

Check whether the customer finished source setup.

For agents

Use the issuing API key and workspace. Completion does not mean data is ready; check the resulting source separately.

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

Response

json

{
  "data": {
    "id": "cses_aaaaaaaaaaaaaaaaaaaaaaaa",
    "connectorId": "conn_aaaaaaaaaaaaaaaaaaaaaaaa",
    "provider": "hubspot",
    "status": "completed",
    "connectorStatus": "syncing",
    "expiresAt": "2026-09-21T12:15:00.000Z"
  }
}