This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of cards given the provided free-text search expression, filtering, and sorting.
By default, cards are sorted by updatedDate in descending order.
For a detailed list of supported filters, sorting options, and search capabilities, see Cards: Supported Filters, Sorting, and Search.
To learn more about working with Search methods, see API Query Language and Sorting and Paging.
| Property | Capabilities | Filters |
|---|---|---|
id | Search: ✗ Aggregate: ✓ Sort: ASC | $eq, $in, $ne, $nin |
pipelineId | Search: ✗ Aggregate: ✓ Sort: ASC | $eq, $in, $ne, $nin |
stageId | Search: ✗ Aggregate: ✓ Sort: ASC | $eq, $in, $ne, $nin |
assigneeId | Search: ✗ Aggregate: ✓ Sort: ASC | $eq, $exists, $in, $ne, $nin |
mainContact.contactId | Search: ✗ Aggregate: ✓ Sort: ASC | $eq, $exists, $in, $ne, $nin |
createdDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $gt, $gte, $lt, $lte, $ne |
updatedDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $gt, $gte, $lt, $lte, $ne |
stageUpdatedDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $gt, $gte, $lt, $lte, $ne |
dueDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $exists, $gt, $gte, $lt, $lte |
staleDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $exists, $gt, $gte, $lt, $lte |
value.value | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $exists, $gt, $gte, $lt, $lte |
tags.privateTags.tagIds | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome, $isEmpty |
additionalContacts | Search: ✗ Aggregate: ✓ Sort: ✗ | $isEmpty, $matchItems |
linkedEntities | Search: ✗ Aggregate: ✓ Sort: ✗ | $matchItems |
description | Search: ✓ Aggregate: ✓ Sort: ✗ | $eq, $exists, $in, $ne, $nin, $startsWith |
mainContact.email | Search: ✓ Aggregate: ✗ Sort: ASC, DESC | $eq, $in, $ne, $nin, $startsWith |
mainContact.phone | Search: ✓ Aggregate: ✗ Sort: ASC, DESC | $eq, $in, $ne, $nin, $startsWith |
name | Search: ✓ Aggregate: ✓ Sort: ASC, DESC | $eq, $in, $ne, $nin, $startsWith |
outcome | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $in, $ne, $nin |
priority | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $in, $ne, $nin |
additionalContacts.email | Search: ✓ Aggregate: ✗ Sort: ✗ | |
additionalContacts.fullName | Search: ✓ Aggregate: ✗ Sort: ✗ | |
additionalContacts.phone | Search: ✓ Aggregate: ✗ Sort: ✗ | |
mainContact.fullName | Search: ✓ Aggregate: ✗ Sort: ✗ |
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.