Search across your master data objects using flexible query parameters
Authorization header.
AND, OR, and wildcards (*).Examples:John - Search for “John” in any fieldJohn AND Smith - Search for records containing both “John” and “Smith”email:*@example.com - Search for email addresses ending with @example.comCustomer, Product, SupplierIndividual Customer, Business CustomerUS Customers, European Customers0 (start from the first result), 10 (start from the 11th result)from for pagination.Example: 10, 25, 50/v1/oauth2/token endpoint. Pass the token directly without the “Bearer” prefix.from and size parameters for pagination.| Status Code | Description |
|---|---|
401 Unauthorized | Invalid or expired access token. Obtain a new token and try again. |
403 Forbidden | You do not have permission to search data objects. Contact your tenant administrator. |
400 Bad Request | Missing required query parameter or invalid parameter values. |
query parameter supports two types of searches: full-text search for finding terms across all fields, and field-specific search for filtering by specific attribute values.
| Pattern | Description | Example |
|---|---|---|
| Simple term | Match records containing the term in any field | John |
| Multiple terms | Match records containing all terms (implicit AND) | John Smith |
| AND operator | Explicit AND between terms | John AND Smith |
| OR operator | Match records containing either term | John OR Jane |
| NOT operator | Exclude records containing a term | John NOT Doe |
| Wildcards | Match partial terms | Jo* (matches John, Jones, etc.) |
| Phrase search | Match exact phrase in sequence | "John Smith" |
| Grouping | Group terms with parentheses | (John OR Jane) AND Smith |
| Operator | Description | Example |
|---|---|---|
eq | Equals - exact match | [First Name] eq "Tim" |
ne | Not equals - exclude exact match | [Status] ne "Inactive" |
gt | Greater than | [Age] gt 21 |
lt | Less than | [Age] lt 65 |
ge | Greater than or equal | [Order Amount] ge 100 |
le | Less than or equal | [Price] le 500 |
contains | Contains substring | [Email] contains "example.com" |
startswith | Starts with value | [Last Name] startswith "Sm" |
endswith | Ends with value | [Email] endswith ".com" |
and and or keywords.
field:value syntax. This allows you to target searches to particular fields in your data objects.
| Pattern | Description | Example |
|---|---|---|
| Exact field match | Match exact value in a specific field | firstName:John |
| Field with wildcard | Match partial values in a field | email:*@example.com |
| Field phrase | Match exact phrase in a field | address.city:"New York" |
| Field range | Match numeric or date ranges | age:[18 TO 65] |
| Field exists | Find records where field has any value | _exists_:email |
| Field missing | Find records where field is empty | NOT _exists_:phone |
| Multiple fields | Combine field filters | firstName:John AND city:Boston |
| Pattern | Description | Example |
|---|---|---|
| Inclusive range | Match values within range (inclusive) | age:[18 TO 65] |
| Exclusive range | Match values within range (exclusive) | age:{18 TO 65} |
| Greater than | Match values greater than | age:>18 |
| Less than | Match values less than | age:<65 |
| Greater or equal | Match values greater than or equal | age:>=18 |
| Less or equal | Match values less than or equal | age:<=65 |
\).
Special characters: + - = && || > < ! ( ) { } [ ] ^ " ~ * ? : \ /
Customer Search Examples
Product Search Examples
Complex Query Examples
businessArea to narrow your search scope.