Skip to main content

Filtering Results

Many API endpoints that return lists of resources support filtering via query parameters. Filters narrow the result set to only matching records.

String Filters​

Pass a plain query parameter to filter by exact match:

curl https://api.attlaz.com/1.13/pulse/catalogs/abc123/products?brand=Nike \
  -H 'Authorization: Bearer {TOKEN}'

Multiple string filters can be combined. Only records matching all filters are returned:

curl https://api.attlaz.com/1.13/pulse/catalogs/abc123/products?brand=Nike&category=Shoes \
  -H 'Authorization: Bearer {TOKEN}'

Some endpoints support a free-text search parameter that performs a partial match (case-insensitive) across relevant fields:

curl https://api.attlaz.com/1.13/pulse/catalogs/abc123/products?search=air+max \
  -H 'Authorization: Bearer {TOKEN}'

Enum Filters​

Some fields accept only specific values. The endpoint documentation lists the allowed values for each enum filter:

curl https://api.attlaz.com/1.13/resources?status=active \
  -H 'Authorization: Bearer {TOKEN}'

Passing an invalid enum value returns a 400 Bad Request error with the allowed options.

Combining Filters with Pagination​

Filters work together with cursor pagination. Apply filters as query parameters alongside limit, starting_after, and ending_before:

curl 'https://api.attlaz.com/1.13/pulse/catalogs/abc123/products?brand=Nike&limit=25&starting_after=abc' \
  -H 'Authorization: Bearer {TOKEN}'

Filter Behaviour​

  • Absent filter parameters return all records (no filtering applied).
  • String filters are exact matches unless otherwise noted.
  • Search filters are case-insensitive partial matches.
  • All filters are AND-combined: records must match every specified filter.