List Portal Entities via Search

Returns paginated search results from the specified entities with the given search parameters.

get
/api/v2/search/{indices}

Query Parameters

qstring

Determines how to filter search results

joinstring

Accepted values are versions and versions.documents. Use commas to separate multiple values.

Example:versions,versions.documents

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Path Parameters

indicesstringrequired

Determines which entity sets to search

Allowed values:product-catalog

Response

application/json

Search Results

SearchResults

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

The paginated results that matched the search query

* Additional properties are NOT allowed.
Show Child Parameters
application/json

SearchResults

object
* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

The paginated results that matched the search query

* Additional properties are NOT allowed.
Show Child Parameters
Example

ProductCatalogIndexSource

object
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequiredread-only

the name of the product

Example:Nice Product

descriptionstringread-only

a description of the product

Example:A nice product for customers to read about and consume

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

document_countnumberrequiredread-only

Number of product documents available.

Example:5

version_countnumberrequiredread-only

Number of product versions.

Example:2

latest_versionobjectrequired

Last created version.

* Additional properties are NOT allowed.
Show Child Parameters
public_labelsobjectrequired

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

Example

SearchIndicesParameters

string

Allowed values:product-catalog