List changes

curl --request GET \
  --url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/changes \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "eventId": "6f1c2d4e-8a3b-4c5d-9e7f-0a1b2c3d4e5f",
      "occurredAt": "2026-10-15T09:30:00.000Z",
      "resource": {
        "id": "CUS_123",
        "type": "customer"
      },
      "revision": 1,
      "type": "customer.created"
    },
    {
      "eventId": "0b9e8d7c-6a5f-4e3d-8c2b-1a0f9e8d7c6b",
      "occurredAt": "2026-10-15T09:30:01.000Z",
      "resource": {
        "id": "REC_456",
        "type": "receivable"
      },
      "revision": 2,
      "type": "receivable.updated"
    }
  ],
  "hasMore": false,
  "nextCursor": "OWMyZjRlNmEtMWIzZC00ZjVhLThjN2UtMmQ0YTZiOGMwZTFmOjI"
}

Changes

List changes

Requires customers:read, receivables:read, or both. Returns committed changes in a stable order with a cursor for resuming after an outage. Each event identifies the resource, its type and its accepted revision, and nothing else: read the resource (which needs its own read scope) for current detail. Events for a resource type are returned only while the grant holds that type’s read scope. Delivery is at least once; discard repeated eventId values. A change is visible only after the mutation that produced it commits, and a rolled-back mutation produces none. Changes are retained for 30 days; a cursor older than that returns 410 change_cursor_expired. To start or resynchronize, request from=latest to obtain a cursor, read the current Customers and Receivables you need, then resume from that cursor. Customer and Receivable changes are produced today; other resource families will add their own types as they become available.

GET

/

v1

/

clients

/

{clientCode}

/

changes

List changes

curl --request GET \
  --url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/changes \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "eventId": "6f1c2d4e-8a3b-4c5d-9e7f-0a1b2c3d4e5f",
      "occurredAt": "2026-10-15T09:30:00.000Z",
      "resource": {
        "id": "CUS_123",
        "type": "customer"
      },
      "revision": 1,
      "type": "customer.created"
    },
    {
      "eventId": "0b9e8d7c-6a5f-4e3d-8c2b-1a0f9e8d7c6b",
      "occurredAt": "2026-10-15T09:30:01.000Z",
      "resource": {
        "id": "REC_456",
        "type": "receivable"
      },
      "revision": 2,
      "type": "receivable.updated"
    }
  ],
  "hasMore": false,
  "nextCursor": "OWMyZjRlNmEtMWIzZC00ZjVhLThjN2UtMmQ0YTZiOGMwZTFmOjI"
}

Authorizations

Authorization

string

header

required

Integration-owned environment-specific API key. Never paste a production key into documentation tools.

Path Parameters

clientCode

string

required

Stable non-sensitive Client code authorized by the Integration grant.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Query Parameters

cursor

string

Opaque cursor from a previous response's nextCursor. Omit it to read from the oldest retained change.

Required string length: 1 - 200

from

string

Use latest, without a cursor, to obtain a cursor positioned after every change committed so far. The response contains no changes.

Allowed value: "latest"

limit

integer

Maximum changes to return, from 1 to 500. Defaults to 100.

Required range: 1 <= x <= 500

Response

A page of changes and the cursor to resume from.

data

object[]

required

Maximum array length: 500

Show child attributes

hasMore

boolean

required

True when more changes are available after nextCursor.

nextCursor

string

required

Cursor to send as cursor on the next request. Always present, including on an empty page; store it only after you have processed data.

Required string length: 1 - 200