Search and filter

Filtering

GET /objects/{object}/resources?filter[{field}]={value}

Filter conditions are AND — all must match. OR is not currently supported.

Basic filter

curl --globoff \
  -H "Authorization: api-key YOUR_API_KEY" \
  "https://api.clarify.ai/v1/workspaces/acme/objects/person/resources?filter[title]=VP%20Engineering"

Filter with operator

curl --globoff \
  -H "Authorization: api-key YOUR_API_KEY" \
  "https://api.clarify.ai/v1/workspaces/acme/objects/deal/resources?filter[amount][Greater%20than]=50000"

Use --globoff with curl to prevent shell expansion of brackets.

Operators by field type

Operators are passed as the second bracket in the filter parameter. Use the exact casing shown — operators are case-sensitive.

Text and long text: Contains, Does not contain, Starts with, Ends with

For text fields, use Contains instead of Equals — exact match (Equals) is not supported on text fields and will return a 400 error.

Number and currency: Is, Greater than, Less than, Greater than or equal, Less than or equal

Dates: Is, Is after, Is before, Is on or after, Is on or before

Single select: Is, Is not, One of, Not one of

Multi select: Contains, Does not contain

Boolean (checkbox): Is, Is not

Collections (email addresses, domains): Contains, Does not contain

Record IDs: Is, Is not

Examples

Find people by email:

filter[email_addresses][Contains]=jane@example.com

Find companies by domain:

filter[domains][Contains]=acme.com

Find deals above a threshold:

filter[amount][Greater than]=50000

Find deals created after a date:

filter[_created_at][Is after]=2024-01-01

Find records by select value:

filter[stage][One of]=Negotiation,Proposal

Including relationships

Use the include parameter to expand related records inline:

curl --globoff \
  -H "Authorization: api-key YOUR_API_KEY" \
  "https://api.clarify.ai/v1/workspaces/acme/objects/person/resources?include=companies,deals"

Ordering

Sort results with sortOrder:

sortOrder[column]=amount&sortOrder[dir]=DESC

See pagination for paging through results.