Query parameters
where, constraint, order_by, limit, skip, and per_page on GET entries.
GET /api/streams/{stream}/entries accepts query parameters implemented in Streams\Api\Endpoints\Entries\ListEntries::applyFilters() (the pre-1.0 GetEntries controller was replaced by this endpoint class).
Parameters
| Parameter | Example | Purpose |
|---|---|---|
where[field] |
where[director]=Lucas |
Equality filter |
constraint[field] |
constraint[director]=like |
Operator: like, >, >=, <, <=, !=, <>, in, between |
order_by[field] |
order_by[title]=ASC |
Sort direction |
limit |
limit=10 |
Max results (with skip) |
skip |
skip=20 |
Offset (default 0) |
per_page |
per_page=20 |
Page size (default 100 in code) |
page |
page=2 |
Page number (default 1) |
with |
with=author,tags or with[]=author |
Eager-load relationship fields (a trailing _id is stripped from the handle) |
Example
curl -s "http://localhost/api/streams/films/entries\
?where[director]=George%20Lucas\
&constraint[director]=like\
&order_by[title]=ASC\
&per_page=20&page=1"
Array values on where fields support operator/operand pairs for advanced filters.