Use this file to discover all available pages before exploring further.
The Search Data Objects endpoint allows you to search through your master data across business areas, schemas, and datasets. You can perform full-text searches and filter results based on your organizational structure.
The search query string. This supports full-text search across all indexed fields in your data objects. You can use standard search operators like AND, OR, and wildcards (*).Examples:
John - Search for “John” in any field
John AND Smith - Search for records containing both “John” and “Smith”
email:*@example.com - Search for email addresses ending with @example.com
Filter results to a specific business area by name. If not provided or set to “all”, the search will include all business areas you have access to.Use the List Business Areas endpoint to get the available business area names for your application.Example:Customer, Product, Supplier
Filter results to a specific schema by name. A schema defines the structure and fields of your data objects within a business area.Use the List Schemas endpoint to get the available schema names for a business area.Example:Individual Customer, Business Customer
Filter results to a specific dataset by name. Datasets are collections of data objects that share the same schema.Use the List Datasets endpoint to get the available dataset names for a schema.Example:US Customers, European Customers
The starting position for pagination. Use this to skip a number of results for implementing pagination.Example:0 (start from the first result), 10 (start from the 11th result)
The 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.
Full-text search looks for matching terms across all indexed fields in your data objects.
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
# Find records containing "John" in any fieldquery=John# Find records containing both "John" and "Smith" anywherequery=John Smithquery=John AND Smith# Find records containing either "John" or "Jane"query=John OR Jane# Find records with "John" but not "Doe"query=John NOT Doe# Find exact phrase "John Smith"query="John Smith"# Find names starting with "Jo"query=Jo*# Complex query with groupingquery=(John OR Jane) AND (Smith OR Doe)
You can also use comparison operators with bracket notation for field names. This syntax is useful when field names contain spaces or special characters.
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"
# Find customers where First Name equals "Tim"query=[First Name] eq "Tim"# Find customers where Last Name equals "Smith"query=[Last Name] eq "Smith"# Find customers where Status is not "Inactive"query=[Status] ne "Inactive"# Find customers older than 21query=[Age] gt 21# Find customers 65 or youngerquery=[Age] le 65# Find orders with amount greater than or equal to $100query=[Order Amount] ge 100# Find products with price less than $500query=[Price] lt 500# Find customers with email containing "example.com"query=[Email] contains "example.com"# Find customers whose last name starts with "Sm"query=[Last Name] startswith "Sm"# Find customers whose email ends with ".org"query=[Email] endswith ".org"
You can combine multiple comparison operators using and and or keywords.
# Find customers named Tim Smithquery=[First Name] eq "Tim" and [Last Name] eq "Smith"# Find customers in CA or NYquery=[State] eq "CA" or [State] eq "NY"# Find active customers aged 18 to 65query=[Status] eq "Active" and [Age] ge 18 and [Age] le 65# Find premium customers with high order valuequery=[Customer Type] eq "Premium" and [Order Amount] gt 1000# Find customers in specific citiesquery=[City] eq "New York" or [City] eq "Los Angeles" or [City] eq "Chicago"# Complex condition with groupingquery=([State] eq "CA" or [State] eq "NY") and [Status] eq "Active"# Find inactive customers or those with no recent ordersquery=[Status] eq "Inactive" or [Last Order Date] lt "2024-01-01"# Find products in Electronics category under $500query=[Category] eq "Electronics" and [Price] le 500 and [In Stock] eq "true"
You can combine bracket notation with standard field syntax in the same query.
# Combine bracket notation with standard syntaxquery=[First Name] eq "Tim" AND address.state:CA# Full-text search with comparison operatorquery=premium AND [Customer Type] eq "Enterprise"# Field-specific with comparison operatorquery=email:*@example.com and [Status] eq "Active"
Filter records by specific attribute values using the 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
# Find customers with first name "John"query=firstName:John# Find customers with last name "Smith" or "Johnson"query=lastName:(Smith OR Johnson)# Find customers with email addresses from example.comquery=email:*@example.com# Find customers in New York cityquery=address.city:"New York"# Find customers in California statequery=address.state:CA# Find customers with a phone number on filequery=_exists_:phone# Find customers missing email addressquery=NOT _exists_:email# Combine full-text and field-specific searchquery=John AND address.state:NY# Find customers in NY or CA with name containing "Smith"query=lastName:*Smith* AND address.state:(NY OR CA)
Use range syntax to filter by numeric values or dates.
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
# Find customers aged 18 to 65 (inclusive)query=age:[18 TO 65]# Find customers aged between 18 and 65 (exclusive)query=age:{18 TO 65}# Find customers older than 21query=age:>21# Find customers 65 or youngerquery=age:<=65# Find orders with amount between $100 and $1000query=orderAmount:[100 TO 1000]# Find records created after a specific datequery=createdDate:>2024-01-01# Find records updated in 2024query=updatedDate:[2024-01-01 TO 2024-12-31]
For data objects with nested attributes, use dot notation to access nested fields.
# Search by nested address fieldsquery=address.city:Bostonquery=address.state:MAquery=address.zipCode:02101# Search by nested contact informationquery=contact.email:*@company.comquery=contact.phone.mobile:+1-555*# Combine nested field searchesquery=address.city:Boston AND address.state:MA# Search nested objects with phrasequery=address.street:"123 Main Street"
If your search term contains special characters, escape them with a backslash (\).Special characters:+ - = && || > < ! ( ) { } [ ] ^ " ~ * ? : \ /
# Search for email with special charactersquery=email:john\+newsletter@example.com# Search for values containing parenthesesquery=company:"Acme \(Corp\)"
# Find customer by full namequery=firstName:John AND lastName:Smith# Find customers by email domainquery=email:*@bigcorp.com# Find customers in a specific regionquery=address.state:(CA OR OR OR WA) AND customerType:Enterprise# Find customers with recent ordersquery=lastOrderDate:>2024-01-01 AND status:Active# Find VIP customers in New Yorkquery=customerTier:VIP AND address.city:"New York"
Product Search Examples
# Find products by SKU prefixquery=sku:PROD-2024*# Find products in a price rangequery=price:[50 TO 200] AND category:Electronics# Find products by brandquery=brand:(Apple OR Samsung OR Google)# Find in-stock productsquery=inventory:>0 AND status:Active# Find products with specific attributesquery=color:Blue AND size:(M OR L) AND inStock:true
Complex Query Examples
# Multi-condition customer searchquery=(firstName:John OR firstName:Jane) AND address.state:CA AND NOT status:Inactive# Product availability searchquery=category:Electronics AND price:[100 TO 500] AND inventory:>10 AND rating:>=4# Full-text with field filtersquery="premium service" AND customerType:Enterprise AND region:(North OR East)# Date range with status filterquery=createdDate:[2024-01-01 TO 2024-06-30] AND status:(Pending OR Processing)