VeroXM Docs

Parameters

These parameters shape a list-entries request - as query string on GET .../content, or as JSON body fields on POST .../content/search, which is the easier way to send where and whereRelation.

Where Clauses

where filters entries by field value. The recommended shape is an array of clause objects, AND'ed together - each object's keys are field names, each value either a literal or an operator object:

where
[
  { "status": "active" },
  { "price": { "gte": "10", "lte": "50" } }
]

Supported operators, as keys on a value object:

OperatorMeaning
likeSubstring match
notNot equal
inComma-separated list of allowed values
not_inComma-separated list of excluded values
lt / lteLess than / less than or equal
gt / gteGreater than / greater than or equal
between / not_betweenComma-separated min,max range

A clause with no operator object matches an exact value - omitting an operator is shorthand for an equality check.

Where Through Relation

whereRelation filters entries by a value on the entrythey relate to, through a Relation field. Its keys are the relation field's name; each value is an object of field-on-the-related-collection → value to match:

whereRelation
{
  "author": { "email": "jane@example.com" }
}

This returns entries whose author relation points at an entry (in the related collection) whose email field contains the given value.

Counting Entries

Pass count (any value - its presence is what matters) to get a total count instead of the entry list, useful for building pagination UI without fetching every page first.

Sorting

sort takes a comma-separated list of field:direction pairs, direction being asc or desc:

sort
sort=publishedAt:desc

Sorting on a built-in column (like publishedAt) happens at the database level. Sorting on a custom field value is applied in application code after the matching entries are loaded - only the first field-based sort key in the list is honored if more than one is given.

Limit and Offset

limit caps the number of entries returned; offset skips that many matching entries before collecting results - standard page-based pagination.

limit and offset
limit=20&offset=40

With or Only Draft

By default, only published entries are returned. Pass state=only_draft to see unpublished (draft) entries instead. Any other or missing state value falls back to published-only, rather than exposing both - a request never accidentally leaks drafts.

Include Timestamp Fields

Pass timestamps (any value) to include an entry's createdAt, updatedAt, and publishedAt fields in the response. They're omitted by default to keep ordinary responses smaller.

Locale

A locale parameter is also accepted on list and search requests - see Localization for how it resolves.