Filtering Data

Overview

Being able to filter data based on specific criteria is a foundational feature in any API. Alloy Unified API is no different.

How it Works

Alloy's Unified API supports filtering on various properties. You can filter by any key in the common model by specifying the parameter in the request query.

Sample Request – filtering by firstName

curl --location 'https://embedded.runalloy.com/2024-03/one/commerce/customers?credentialId=YOUR_CREDENTIAL_ID&firstName=John' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Accept: application/json'

The choice of query params available can be found in the API reference of the corresponding resource endpoint.

Wrapping Up

In this article, we took a look at how to filter data using Alloy's Unified API.