Sign In

Search

Some top level API resources support retrieval with search API methods. You can use the search APIs to retrieve our objects in a flexible manner. Using search is a faster alternative to paginating through all resources. To create a search query, review the Search query language and reference the unique query fields available for the resource.

The Search functionality and syntax defined on this page is in the proposal phase of the development process. It may change without warning.


Quotes

You must use quotation marks around string values. Quotation marks are optional for numeric values.


Search Syntax

field:value

Exact match operator (case insensitive).

field:null

A special token used for field presence (case insensitive).

field~value

Substring match operator (substrings must be a minimum of 3 characters).

field<value

Less than operator.

field>value

Greater than operator.

field<=value

Less than or equal to operator.

field>=value

Greater than or equal to operator.


Rate Limits

We apply a rate limit of up to 20 read operations per second which applies for all search endpoints in both live mode and test mode. Live mode and test mode limits are separate.