Pagination
Pagination lets you read a list in smaller windows instead of asking for every row at once.
The Universal API uses the same pagination shape across apps: pass limit to choose how many rows you want, and pass offset to choose how many rows to skip before the page starts. MindCloud handles the provider-specific pagination details behind the action.
The controls
| Control | What it does |
|---|---|
limit | Maximum number of rows to return. |
offset | Number of rows to skip before returning results. |
Both controls are query parameters on the Universal API request. They are not action arguments, and they do not go inside the JSON body.
Requesting a page
For a GET action, add limit and offset next to the other query parameters:
curl --request GET \
--url "https://embedded.mindcloud.co/v1/universal/slack/latest/actions/list-users" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID" \
--data-urlencode "limit=2" \
--data-urlencode "offset=0"For a POST, PUT, or PATCH action, connectionId still goes in the body, but limit and offset stay in the URL:
curl --request POST \
--url "https://embedded.mindcloud.co/v1/universal/slack/latest/actions/search-users?limit=2&offset=0" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"query": "engineering"
}'How to move through pages
Start with offset=0. After each successful request, add the number of rows you asked for to the offset:
| Request | Query | Rows returned |
|---|---|---|
| First page | limit=2&offset=0 | Ava, Ben |
| Second page | limit=2&offset=2 | Cora, Dev |
| Third page | limit=2&offset=4 | Eli |
Move forward by increasing offset by limit each time: 0, 2, 4, and so on.
Stop when the page returns fewer rows than your limit. If the response also includes pagination metadata that says there is no next page, you can stop there too.
What MindCloud handles
Some providers use page numbers. Some use offsets. Some use cursors. You do not need to normalize those formats in your code.
When an action supports pagination, your code still sends limit and offset. MindCloud translates that request into the provider-specific pagination model for the selected app connection.
Paginated Actions
The actions below support pagination for this app version.
- List Chain Keys
- List Chains
- List Charge Events
- List Charge Refunds
- List Charge Schedules
- List Charges
- List Closed Disputes
- List Customer Cards
- List Customer Schedules
- List Customers
- List Dispute Documents
- List Disputes
- List Events
- List Link Charges
- List Linked Accounts
- List Links
- List Open Disputes
- List Pending Disputes
- List Receipts
- List Recipient Schedules
- List Recipients
- List Refunds
- List Routing Group Rules
- List Schedule Occurrences
- List Schedules
- List Sub Merchants
- List Transactions
- List Transfer Schedules
- List Transfers
- List Webhook Secrets
- Search Charges
- Search Customers
- Search Links