Skip to main content

Filtering and sorting

Filtering​

Most list endpoints accept resource-specific filters as query parameters. Range filters use bracket suffixes:

GET /v1/emails?status=approved
&created_at[gte]=2026-01-01T00:00:00Z
&created_at[lt]=2026-02-01T00:00:00Z

Supported operators on date and numeric fields: gt, gte, lt, lte, plus in (comma-separated list) on every field. Array fields such as to match rows that contain the value (?to=x@y.com). Each resource accepts only the filters listed on its page under Resources; an unknown filter, an unsortable field or a malformed value (a non-UUID id, a bad timestamp) is rejected with 400 validation_failed.

Sorting​

GET /v1/emails?sort=-created_at

Prefix - for descending order. Multiple sort keys may be comma-separated (sort=from,-created_at); id is always the final tie-breaker. The default is -created_at (newest first). Only the fields listed on each resource's page under Resources may be sorted — they are non-nullable columns so keyset pagination stays exact.