Get Records
Appflow APIs
Get Records
POST
Get Records
Fetch records for a specific entity with optional filtering and token-based pagination. This endpoint is used by the AppFlow connector to pull data from Superleap during flow execution.
Headers
Bearer token for authentication, click here to generate one
application/json
Path Parameters
The entity identifier for the object (e.g., “lead”, “user”, “opportunity”). Use the List Objects endpoint to discover available identifiers.
Body
Query object containing field selection and filter parameters
Pagination token returned from a previous response. Pass
null for the first request. When the response includes a next_token, pass it in the next request to retrieve the following page of results.Example Request
Example Response
Response Fields
| Field | Type | Description |
|---|---|---|
success | boolean | Whether the request was successful |
data.records | array | List of record objects with the requested fields |
data.next_token | string | null | Pagination token for the next page. null when there are no more results. |
Pagination
Records are returned in pages. When the response includes a non-nullnext_token:
- Pass the
next_tokenvalue in your next request to retrieve the following page - Continue paginating until
next_tokenisnull - Each page may contain up to 3000 records
Incremental Sync
For incremental data syncs, filter by a timestamp field (e.g.,updated_at) using the gte operator with a Unix timestamp in milliseconds. This allows you to fetch only records that have been modified since your last sync.