Query Syntax

Parameter Description
author Entry author. Service returns entries where the author name or email matches the query string.
itemsPerPage Number of result items to retrieve per page.
orderBy Expression for sorting a collection of results. The format is ?orderBy=<field name> <sort order>[, <field name> <sort order>]. Ascending / descending order is specified by appending “asc” or “desc”.


  • http://api.example.org/resource?orderBy=updatedAt desc,material-format asc
publishedMin, publishedMax Bounds on entry publication date.
q Full-text query string.
Keyword search
  • A keyword search uses one or more complete words that are contained anywhere in the item's record.
  • Example: q=dog
Phrase search
  • A phrase search uses quotation marks to allow an exact match to the phrase searched.
  • Example: q=”exact phrase search”
Boolean operators
  • Boolean operators allow you to group, include, or exclude certain terms in your search.
  • AND operator. When creating a query, list search terms separated by spaces, in the form q=term1 term2 term3. As with all of the query parameter values, the spaces must be URL-encoded. The service returns all entries that match all of the search terms (like using AND between terms).
  • Example: q=book hardcover collector
  • OR operator. The use of OR will search for either of the terms listed in the query string, q=term1 OR term2.
  • Example: q=dog OR cat
  • Exclude operator. The minus sign (-) will exclude terms from your search. Specify the query as q=term1 – term2.
  • Example: q=paris – fashion (meaning search for paris but not fashion)
  • Parenthesis can be used to further specify order of operations within the boolean query. The order of operations should be handled as follows: a) inner most parens, b) exclude operator, c) AND operator, d) OR operator.
  • <Example: q=dog AND ((cat OR food) - treats)
  • Wildcards are special characters used to represent additional characters in a search term. They are useful when you are unsure of spelling, when there are alternate spellings, or when you only know part of a term.
  • Pound sign (#).   The pound sign, also called a number sign or hash mark, represents a single character.
  • Example: q=wom#n Returns items whose record contains “woman”, “women”, etc.
  • Question mark (?).  The question mark (?) represents any number of additional characters.
  • Example: q=m?n Returns items whose record contains “man”, “men”, “moon”, “maroon”, etc.
  • Truncation allows you to search for a term and its variations by entering a minimum of the first three letters of the term followed by an asterisk (*).
  • Example: q=invest* Returns items whose records contain “investor”, “invested”, “investing”, “investment”, etc.
  • The search is case-insensitive.
  • To allow for index specific searching, specify the query as index:term. Example: q=title:dog and title:cat
  • The absence of the “q” parameter will default to return all items available for that service. It is the same as specifying q=* to return all items in the service.
startIndex 1-based index of the first result to be retrieved
strict Strict query parameter checking.
  • Set strict=true to have the service verify that each of the query parameters are recognized by the service.
  • Default strict=false
updatedMin, updatedMax Filter by entry update date.

Custom Query Options

A custom query option is any query string parameter not defined as part of this standard set query parameters. Web services may support custom query parameters for web-service-specific functionality.