Knips logoKnips API

Pagination & filtering

Page, filter and sort list endpoints.

List endpoints (such as feeds) share a set of query parameters, all prefixed with $.

ParameterTypeDescription
$offsetintegerNumber of items to skip. Defaults to 0.
$limitintegerMaximum number of items to return in one page.
$filterstringNarrows the result to items matching an expression.
$orderBystringField to sort by, with an optional direction.

Paging through results

Combine $offset and $limit to walk the collection. The meta.maxResults field in the response tells you the total number of matching items, so you know when to stop.

# First page
curl "https://api.knips.tech/feeds?\$offset=0&\$limit=20" -u "ACCESS_KEY:SECRET"

# Next page
curl "https://api.knips.tech/feeds?\$offset=20&\$limit=20" -u "ACCESS_KEY:SECRET"

Remember to URL-encode the $ (%24) if your HTTP client treats it specially, and to quote the URL in a shell so $limit isn't read as a variable.

Sorting

Pass a field name followed by a direction — asc (default) or desc, separated by a space:

?$orderBy=createdAt desc

Filtering

$filter takes an OData-style expression of the form field operator value, with string values in single quotes. Combine conditions with and / or.

OperatorMeaning
eq / neequals / not equal
gt / gegreater than / greater than or equal
lt / leless than / less than or equal
liketext match
invalue is in a list
betweenvalue is within a range
?$filter=name eq 'Summer campaign'
?$filter=created gt '2026-01-01' and archived eq false

The set of filterable fields depends on the endpoint — see each endpoint's reference page for what it accepts.

On this page