Search Language

A language to filter results in endpoints that support the search language

The search language filter syntax provides a powerful way to filter API results. Use this query language to narrow down results based on specific field values.

Use the q query parameter to specify the search language filter syntax.

Each endpoint has a list of supported fields which you will need to consult to determine which fields are available for filtering.

Basic Syntax

q={FIELD}{OPERATOR}"{VALUE}" {AND|OR} {FIELD}{OPERATOR}"{VALUE}" ...

Ensure that the value is enclosed in double quotes.

Examples

name:"John"
created_at>"2023-01-01"
status!:"inactive"

Supported Operators

:Equalsname:"Smith"

!:Not equalsstatus!:"deleted"

~Containstags~"urgent"

!~Does not containdescription!~"draft"

>Greater thanprice>"50"

<Less thanstock<"10"

>=Greater than or equal torating>="4"

<=Less than or equal topriority<="3"

Combining Filters

Connect multiple conditions using AND or OR:

status:"active" AND created_at>"2023-01-01"
priority:"high" OR due_date<:"2023-12-31"

Relationship Filtering

Access related resources using dot notation:

user.name:"John"
order.items.count>"5"

Notes

Parentheses grouping is not supported

All conditions are evaluated left-to-right

Values must be enclosed in double quotes

Example API Usage

GET /api/channels/listings?q=title:"Chair" AND title:"Table"