List records
You can use this endpoint to build a consumer off of your account’s records stream. This is a simple and fast alternative to the Consume API.
Request parameters
By default, this endpoint returns all records across all syncs and collections in your account. To filter the records returned, you can send along one or all of the following request parameters:
Filter for records for this particular sync.
Defaults to all syncs.
Filter for records from this provider. Value is the provider’s slug, e.g. stripe
. See the list of possible values.
Defaults to all providers.
Filter for records for this collection (e.g. Stripe’s stripe:subscription
or Salesforce’s salesforce:contact
).
Defaults to all collections.
Filter for records with a cursor greater than this value. Used to paginate the stream (see Pagination).
Defaults to null
, which means the first page of records is returned (the earliest records in the stream).
The maximum number of records to return. Can request up to 500 records at a time.
Defaults to 100
.
Response fields
The response is an object that contains an array of record objects:
An array of record objects.
The cursor you can use to fetch the next page of records.
The cursor will always be returned, even if there are currently no more records to fetch. See Pagination below for more details.
The records in the response are ordered by updated_idx
in ascending order (oldest first).
Pagination
The response will always contain a cursor
field, even if there are no more records to fetch. Simply send back the cursor
from the last response to fetch the next page of records.
If you send a cursor
and there are no more records to return, the response will contain an empty records
array and the same cursor
value you sent.
Was this page helpful?