Cards: Supported Filters, Sorting, and Search

This article covers field support for filtering, sorting, and searching in the Cards API.

Overview

The Cards API includes three endpoints for querying and searching cards:

Query Cards for basic querying with filters and sorting.
Search Cards for enhanced searching with full-text search, filters, and sorting.
Search Cards by Stage for searching cards within specific pipeline stages.

Note: The filterable, sortable, and searchable fields differ between the Query and Search endpoints. Search endpoints offer more comprehensive filtering and sorting capabilities.

Query Cards

The table below shows field support for filters and sorting for the card object:

Field	Supported Filters	Sortable
`id`	`$eq`, `$ne`, `$in`, `$nin`
`pipelineId`	`$eq`, `$ne`, `$in`, `$nin`
`stageId`	`$eq`, `$ne`, `$in`, `$nin`
`createdDate`	`$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte`	Sortable
`updatedDate`	`$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte`	Sortable

Search Cards

The table below shows field support for filters, sorting, and free-text searching for the card object:

Field	Supported Filters	Sortable	Searchable
`id`	`$eq`, `$ne`, `$in`, `$nin`	Sortable
`pipelineId`	`$eq`, `$ne`, `$in`, `$nin`	Sortable
`stageId`	`$eq`, `$ne`, `$in`, `$nin`	Sortable
`createdDate`	`$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte`	Sortable
`updatedDate`	`$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte`	Sortable
`stageUpdatedDate`	`$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte`	Sortable
`name`	`$eq`, `$ne`, `$in`, `$nin`, `$startsWith`	Sortable	Searchable
`description`	`$eq`, `$ne`, `$in`, `$nin`, `$startsWith`, `$exists`		Searchable
`priority`	`$eq`, `$ne`, `$in`, `$nin`	Sortable
`outcome`	`$eq`, `$ne`, `$in`, `$nin`	Sortable
`assigneeId`	`$eq`, `$ne`, `$in`, `$nin`, `$exists`	Sortable
`dueDate`	`$eq`, `$gt`, `$gte`, `$lt`, `$lte`, `$exists`	Sortable
`staleDate`	`$eq`, `$gt`, `$gte`, `$lt`, `$lte`, `$exists`	Sortable
`value.value`	`$eq`, `$gt`, `$gte`, `$lt`, `$lte`, `$exists`	Sortable
`mainContact.contactId`	`$eq`, `$ne`, `$in`, `$nin`, `$exists`	Sortable
`mainContact.fullName`	`$eq`, `$ne`, `$in`, `$nin`, `$startsWith`	Sortable	Searchable
`mainContact.email`	`$eq`, `$ne`, `$in`, `$nin`, `$startsWith`	Sortable	Searchable
`mainContact.phone`	`$eq`, `$ne`, `$in`, `$nin`, `$startsWith`	Sortable	Searchable
`mainContact.displayName`	`$eq`, `$ne`, `$in`, `$nin`, `$startsWith`	Sortable
`additionalContacts.contactId`	`$hasSome`, `$hasAll`
`additionalContacts.fullName`	`$hasSome`, `$hasAll`		Searchable
`additionalContacts.email`	`$hasSome`, `$hasAll`		Searchable
`additionalContacts.phone`	`$hasSome`, `$hasAll`		Searchable
`additionalContacts`	`$empty`, `$matchItems`
`tags.privateTags.tagIds`	`$hasSome`, `$hasAll`, `$empty`
`linkedEntities`	`$matchItems`
`linkedEntities.entityId`	`$eq`, `$ne`, `$in`, `$nin`, `$exists`
`linkedEntities.referencedEntity`	`$eq`, `$ne`, `$in`, `$nin`, `$exists`

Supported Aggregation Types

Type	Description
`SCALAR`	Calculates single numerical values such as card totals, min, or max values.
`VALUE`	Groups by field values and counts occurrences, such as cards by priority or cards by stage.
`RANGE`	Groups values by defined ranges.
`DATE_HISTOGRAM`	Groups by time intervals, such as cards created per week or month.

Related content: API Query Language, Query Cards, Search Cards, Search Cards By Stage

Did this help?