HomeGuidesAPI Reference
API Reference

Fetch records in bulk via S3

Fetch multiple customer records and return signed URLs to download them from S3. Handles large datasets by chunking data into multiple files. Max 300,000 records at a time. Data will be split into files of max 10,000 records.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number

Unix timestamp (milliseconds) to fetch records created after this date

number

Unix timestamp (milliseconds) to fetch records created before this date

number

Unix timestamp (milliseconds) to fetch records updated after this date

number

Unix timestamp (milliseconds) to fetch records updated before this date

number
required

Maximum number of records to fetch (up to 300,000).

string

Pagination token for cursor-based pagination. Use the token from the response to fetch the next page of results.

boolean

Adds a top-level parentIds array to every record. Present only when appendParentIds=true. The ids of every record that has this record as the interested party of a relation, one level up, sorted, each id once. Archived parents are included (check their status); deleted ones are not. Not to be confused with data.parentIds, a copy of form or vendor input that is never kept in sync: rely on this top-level field. A record's updatedAt does not change when a relation concerning it changes, so updatedAfter / updatedBefore do not reliably return the records whose parentIds changed. Run a full extraction (no date filters) to get current parentIds.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json