/search

get

https://developer.interactgo.com/api/search

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This method is used to perform searches against the Interact search index. This is identical to using the top search bar in the Interact web platform.

The search term is the only mandatory parameter and must be at least 2 characters long or you can use an asterisk to search for all content.

📘
Interacts events can be configured to be viewed across all calendars. To return events configured this way, you should specify a sectionId of 0. This will return all events shared across all calendars

For a list of options for Search Type and Order By fields see Enumerated types

Query Params

searchTerm

string

required

This is the term to search for. This must be at least 3 characters long

type

string

This is the type of content to search for.

excludedTypes

string

This is a comma separated list of content types to be excluded from the search

limit

int32

This is the maximum number of records to return

offset

int32

This is the record number to start from. Can be used in conjunction with limit to perform pagination

sortBy

string

Defaults to Relevance

The sort field, choose from Relevance, DateDesc, DateAsc, or Title

sectionId

array of int32s

If specified, this will limit the search to the specified content sections

sectionId

includeChildSections

boolean

Defaults to true

If this is specified then the search will recursively search the children of the specified sections

hashtags

array of strings

If specified, this will limit the search results to only those with at least one matching hash tags

hashtags

Response

Interacts events can be configured to be viewed across all calendars. To return events configured this way, you should specify a sectionId of 0. This will return all events shared across all calendars

200200