Advanced Query DSL
A unified URL-parameter-based filtering syntax shared by all list endpoints: GET /{endpoint}?filter[field][op]=value&offset=n&limit=n
Operators
| Operator | Description |
|---|---|
| _eq | Equal to |
| _neq | Not equal to |
| _gt | Greater than |
| _gte | Greater than or equal to |
| lt | Less than |
| _lte | Less than or equal to |
| _contains | SQL LIKE — substring match |
| _not_contains | SQL NOT LIKE |
Value types
| Type | Format | Example |
|---|---|---|
| String | Plain text | paid |
| Number | Plain numeric | 100/99.99 |
| Boolean | 0= false, 1 = true | 1 |
| Date / Time | RFC 3339 with timezone | 2026-01-05T15:43:18+08:00 |
Pagination
| Parameter | Description |
|---|---|
| offset | Starting record index |
| limit | Records per page (max 1000) |
Examples
| Scenario | Query |
|---|---|
| Exact match | filter[correspondence_state][_eq]=paid |
| Range | filter[initial_total][_gte]=100 & filter[initial_total][_lte]=500 |
| Text search | filter[name][_contains]=John |
| Combined filters | filter[initial_total][_gte]=100 & filter[correspondence_state][_eq]=paid |
Used by these APIs
Get customersAPI
Get ordersAPI
Get transactionsAPI
Get recurring itemsAPI
Get recurring configsAPI
Get recurring plansAPI
Get recurring ordersAPI
Get plan ordersAPI
Get payout requestsAPI