Use Cases

Search for customers

Say you have a number of laundromats as customers, many of which are franchises. You might have those franchises set up hierarchically, with the main store or corporate office as the parent account responsible for paying the bills, and all other stores as child accounts.

Let's say you want to find some of those parent accounts, but only the ones that are still active customers. You can do that by searching for open parent accounts that have "laundr" in their name (as in "laundromat" or "laundry").

curl --request GET \
  --url 'https://restapi.rev.io/v1/Customers?is_parent=true \
  &status=OPEN \
  &name=laundr'

If you know you're going to get a lot of accounts back, you might want to specify a high page size. The number of the page size determines how many accounts we'll return in a single response.

curl --request GET \
  --url 'https://restapi.rev.io/v1/Customers?is_parent=true \
  &status=OPEN \
  &name=laundr \
  &page_size=100'

You could also make multiple requests instead, specifying a different page number each time. You'll know you need to request more pages if our response includes "has_more": true.

curl --request GET \
  --url 'https://restapi.rev.io/v1/Customers?is_parent=true \
  &status=OPEN \
  &name=laundr \
  &page_size=10 \
  &page=2'