Qodex.ai

Content search

GET {{baseUrl}}/.api2/api/v{{apiVersion}}/communities/:communityKey/search/contentDetailed

This endpoint can be used to search for any object or content in a digital workplace. Returns a truncated version of the content for use in search result displays.

The following content will not be included in this search:

  • User accounts
  • Content of pages or spaces
  • Dashboards
  • Tasks

Request Params

| Key | Datatype | Required | Description | | query | null | | String

The string to search the digital workplace for. See the Igloo Help Center search documentation for details on structuring query strings.

If this parameter is blank or not included, the response will include all objects in the digital workplace. | | limit | null | | Integer

The number of results to return per call.

Default: 10 | | offset | null | | Integer

The index at which to start results for pagination. If more results are returned than the limit parameter allows, the offset can be used to return the next page of results in a second call.

For example, if the limit is set to 10, to return the second page of results, the offset should be 10, meaning the returned results will begin with the tenth result.

Default: 0 | | applications | null | | String

A comma-separated list of applications to limit the search to. This can be either the names of the object types, or a number representing each type.

Examples:

  • blog,forum,pages
  • 2,4,9

Accepted values:

  • Blog (1)
  • Wiki (2)
  • Document (3)
  • Forum (4)
  • Calendar (6)
  • Pages (7)
  • Space (9)
  • MicroBlog (10)

Default: All | | updatedDateType | null | | String

Limits the search to only objects updated within the specified timeframe.

Accepted values:

  • PastHour
  • PastTwentyFourHours
  • PastWeek
  • PastMonth
  • PastYear | | labels | null | | Integer

A comma-separated list of label IDs. This limits the results to objects associated with all of the listed labels.

Examples:

  • 688363
  • 688363,387264 | | authorIds | null | | String (GUID)

A comma-separated list of user IDs. Limits results to those created or updated by the specified users.

Examples:

  • {{$randomUUID}}
  • {{$randomUUID}},{{$randomUUID}} | | parentHref | null | | String

The relative path of a parent object to search beneath. Searches only content nested beneath a given parent object. This can be a channel, page or space, and will include results from any nested channels or objects.

Examples:

  • /kb_wiki
  • /hr/forum
  • /accounting-dept | | includeMicroblog | null | | Boolean

Dictates whether microblog content is included in search results.

Default: True | | includeArchived | boolean | | Boolean

Dictates whether to include archived content in search results.

Default: False |

HEADERS

| Key | Datatype | Required | Description | | Cookie | string | | | | Accept | string | | |

RESPONSES

status: ``