Skip to main content

SearchParms

Parameters specifying search attributes or a cursor to get results from a previous search.

Properties

NameTypeDescriptionNotes
attributesList[str]Users search only: additional, non-core attributes to include in the returned object. Attribute names are specific to the returned object.[optional]
cursorstrIdentifies the page to return when paging over a result set--if present, search by / order by attributes are ignored.[optional]
limitintIdentifies the maximum number of items to include in a page (1-100).[optional]
order_by_attributeOrderByAttribute[optional]
search_by_attributesList[SearchByAttribute]Identifies attributes for searching purposes. Some end-points have pre-defined values and ignore this attribute.[optional]

Example