API Docs
Community

Pagination Parameters

Learn how pagination works.

The below parameters are available to you for pagination. These parameters filter and display results based on the object id entered by you. These parameters DO NOT filter results based on the timestamp.

The Get All API response can be paginated using the below parameters.

  • start_before: Returns details of objects before the specified object id.
  • start_after: Returns details of objects after the specified object id.

📘

Start Before and Start After Mutually Exclusive.

The start_before and start_after query parameters are mutually exclusive. That is, they cannot be used together as part of the same API call.

However, the parameters can be used with the results_per_page parameter.

Example

Let us assume 5 beneficiaries were created on ZWITCH.

Beneficiary NameBeneficiary ID
Beneficiary 5vab_Do1neSKz5NEbpZwZNB0bY0005
Beneficiary 4vab_Do1neSKz5NEbpZwZNB0bY0004
Beneficiary 3vab_Do1neSKz5NEbpZwZNB0bY0003
Beneficiary 2vab_Do1neSKz5NEbpZwZNB0bY0002
Beneficiary 1vab_Do1neSKz5NEbpZwZNB0bY0001

  • start_before = vab_Do1neSKz5NEbpZwZNB0bY0003, response contains details of Beneficiary 4 and Beneficiary 5. That is, all results that appear before the entered id.

  • start_after = vab_Do1neSKz5NEbpZwZNB0bY0003, response contains details of Beneficiary 2 and Beneficiary 1. That is, all results that appear after the entered id.

  • start_before = vab_Do1neSKz5NEbpZwZNB0bY0003 and results_per_page is 1, response contains details of Beneficiary 4.

  • start_after = vab_Do1neSKz5NEbpZwZNB0bY0003 and results_per_page is 1, response contains details of Beneficiary 2.