Page through and search customers

1 min

GET

https://app.amberflo.io/customers/paging

This endpoint allows you to page through the list of customers, filter, sort and search customers.

For more details, see Searching, Paging, and Sorting.

limitinteger<int32>Maximum number of customers per page.

pageinteger<int32>Page number.

isAscendingboolean

sortstringWhich field to sort the customers by.

searchstringFilter customers by searching for the provided string in <code>customerName</code>, <code>customerId</code> and <code>customerEmail</code>.

enabledbooleanIf set, filter customers by their status: enabled (<code>true</code>) or disabled (<code>false</code>).

idlistarrayComma separated list of `customerId`s to retrieve. When providing this parameter, the others are ignored.

lifecycleStagestringFilter customers by lifecycle stage.

deletedCustomersstringFilter customers based on their deleted state. By default deleted customers will not be included in the response. <ul> <li><code>INCLUDE</code> - includes deleted customers in the results.</li> <li><code>EXCLUDE</code> - does not include deleted customers in the results.</li> <li><code>ONLY</code> - returns only deleted customers in the results.</li> </ul>

200Successful request

curl --request GET \
     --url https://app.amberflo.io/customers/paging \
     --header 'accept: application/json'

This endpoint allows you to page through the list of customers, filter, sort and search customers.

For more details, see Searching, Paging, and Sorting.