v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

user connections

Retrieve a user connection's syncs

Requires user:read scope.

get/users/{userId}/connections/{connectionId}/syncs

Path parameters

userIdstring required

The user Id

connectionIdstring required

The connection id

Query parameters

limitinteger

The total number of records to retrieve

offsetinteger

The offset at which to start retrieving records

Response

Successful Syncs Response

metaobject

Example response

{
  "data": [
    {
      "id": "5f8f299f-8fad-4fe0-a94f-db4316fbc977",
      "connectionId": "1ffe704d39629a929c8e293880fb449a:d64751de-1254-4ec5-b3e7-e5b53d88c6b6",
      "action": "auto-update",
      "method": "ADD",
      "fetchStatus": "success",
      "createdAt": "2021-02-23T15:14:51.015Z",
      "fetchedAt": "2021-02-23T15:14:51.015Z",
      "accounts": [
        {
          "providerId": "provider-id"
        }
      ]
    }
  ]
}