Retrieve saved read progress or export its rows

Retrieves only this grant’s unexpired job, with authorization checked again. No new bank request is made. JSON contains state, pages, nextCursor, rowsComplete, fetchedAt, intent (null when not supplied), and an error or partial-result reason when applicable.

GET /connect/reads/{runId}

Retrieve saved read progress or export its rows

cURL

curl --request GET \
  --url https://paygent-cloud-server-production.up.railway.app/connect/reads/{runId} \
  --header 'x-paygent-connect-app-key: <api-key>' \
  --header 'x-paygent-connect-grant: <api-key>'

200

{
  "intent": {
    "purpose": "<string>",
    "taskId": "<string>",
    "requestedBy": "<string>"
  },
  "pages": [
    {
      "data": {},
      "fetchedAt": "2023-11-07T05:31:56Z",
      "executionId": "<string>",
      "sessionId": "<string>"
    }
  ]
}

Authorizations

connectAppKey & connectGrantconnectGrant

x-paygent-connect-app-key · string · header · required

A Connect app key (pgc_app_…), identifying the registered third-party app. Always presented together with connectGrant — the pair is one credential, and either half alone is refused. Accepted on the /connect/* surface only.

x-paygent-connect-grant · string · header · required

A Connect grant token (pgc_grant_…): one user's consent for the presenting app to reach one deployment. Every failure mode — missing, malformed, revoked, expired, or paired with the wrong app key — answers the same 401 invalid_connect_credentials.

Path Parameters

runId · string<uuid> · required

Query Parameters

format · enum<string> · default: json

Available options: json, csv

Response

200

application/json

Stored progress, including explicit completeness and freshness.

intent · object | null · required

Optional caller-supplied context for record keeping. Include the known purpose by default, or omit/use null when unknown. This is not an instruction or a verified identity. Avoid credentials and full conversations. Stored encrypted with the read job for 24 hours; save the JSON metadata for longer retention.

Show child attributes

pages · object[]

Show child attributes