One filter language for search

How it works

Every record type in ShipGenius is searched with the same filter expressions, in the app and in the API. A filter you build on a table works the same way in an API search, so your integration gets back the records you see on screen.

Building filters in the app

Choose Add Filter on a list to pick a field, an operator and a value. Group filters with Add Filter Group, and save a filter you use often so you can pick it again from Saved Filters. A saved filter can also narrow which records send a webhook.

Filters in the API

In the API, a filter is a tree of comparisons joined with and, or and not. A comparison can check a field against a fixed value, another field, a time relative to now, or a count or total from related records. Searches return pages of results with cursors for the next page, and data exports take the same filters.

The Searching page of the API reference covers the full language.