Learn about the common query parameters available to filter the Get All API response.
You can filter the results of all our Get All APIs using the from_date
and to_date
parameters.
These parameters filter results using the created_at timestamp. The filtered response is sorted in the descending order.
From Date and To Date Together Only
The
from_date
andto_date
filter parameters have to be used together. They cannot be used by themselves.
These parameters can be in conjunction with the results_per_page
, start_before
, and start_after
parameters for pagination.
Example
Let us assume 5 beneficiaries were created on ZWITCH.
Beneficiary Name | Beneficiary ID | Timestamp |
---|---|---|
Beneficiary 5 | vab_Do1neSKz5NEbpZwZNB0bY0005 | 1645522069 |
Beneficiary 4 | vab_Do1neSKz5NEbpZwZNB0bY0004 | 1645522067 |
Beneficiary 3 | vab_Do1neSKz5NEbpZwZNB0bY0003 | 1645522065 |
Beneficiary 2 | vab_Do1neSKz5NEbpZwZNB0bY0002 | 1645522063 |
Beneficiary 1 | vab_Do1neSKz5NEbpZwZNB0bY0001 | 1645522061 |
-
from_date
= 1645522062 andto_date
= 1645522068, response contains details of Beneficiary 4, Beneficiary 3, and Beneficiary 2. -
from_date
= 1645522062,to_date
= 1645522068, andresults_per_page
is 2, response contains details of Beneficiary 3, and Beneficiary 2.