Skip to main content
POST
Search Records

Filtering Guide

The Search Records endpoint lets you filter, sort, and paginate records using a JSON request body. All three top-level fields (filter, sorting, paging) are optional.

Filter Condition Types

Filters are passed in filter.condition. There are four types, determined by the operator.

Binary Conditions

Compare a field to a value:

Unary Conditions

Check whether a field is empty — no rightSide needed:

Ternary Conditions

Range-based checks with lowerBound and upperBound:

Composite Conditions

Combine multiple conditions with AND or OR:

Relative Date Values

For date fields, you can use relative date strings instead of fixed ISO 8601 dates:

Complete Example

Find active contacts named “acme” with an amount over 1000, created this month:

Authorizations

Softr-Api-Key
string
header
required

Path Parameters

databaseId
string
required
tableId
string
required

Query Parameters

fieldNames
boolean
default:false

If true, use field names as keys in the fields object instead of field IDs.

Body

application/json
filter
object
sort
object[]
paging
object

Response

A paginated list of matching records.

data
object[]
metadata
object