REST API Pagination Documentation
Pagination Overview
Our API supports cursor-based pagination for all endpoints that return a list of items. This method provides efficient and consistent data retrieval, ensuring optimal performance for large datasets.
Pagination is handled using the starting_after
parameter, which acts as a cursor. This parameter should be set to the ID of an existing object (see examples below) and will return the next set of results in reverse chronological order based on their creation time.
By using starting_after
, clients can retrieve data incrementally, while ensuring seamless navigation through result sets.
Query Parameters
Parameter | Type | Required | Description |
---|---|---|---|
starting_after | string | No | A cursor that points to the last retrieved item. The next page will contain results after this value. |
limit | number | No | The number of items to return per page. Defaults to 10 . Must be between 1 and 100 . |
Response Structure
All paginated responses follow the structure:
Property | Type | Description |
---|---|---|
data | T[] | An array of data items of type T . |
hasMore | boolean | Indicates if more data is available. |
nextCursor | string (optional) | The cursor for the next page, if available. |
Example
Get request to retrieve the elt syncs:
GET https://connect.weld.app/elt_syncs?limit=10
Response:
"hasMore": true,
"nextCursor": "D0IAlsVMvPlUr7"
"data": [
{
"id": "D0IAlsVMvPlUr7",
"status": "RUNNING",
"sync_interval": "0 0 * * *",
"destination_schema_name": "instagram_business",
"source_integration_id": "instagram-business",
"destination_integration_id": "bigquery",
"start_date": null,
"created_at": "2025-01-13T13:44:00.374Z",
"updated_at": "2025-01-13T13:44:02.699Z"
},
...
]
Fetching the next page:
GET https://connect.weld.app/elt_syncs?limit=10&starting_after=D0IAlsVMvPlUr7