List Konnect Entities via Search

Retrieves a list of Konnect entities matching the search query provided.

get

Query Parameters

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[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

qstringrequired

The query that defines the search criteria. Supports Lucene-like syntax for filtering results. Learn more about search query syntax here.

Example:name:"John Smith"

Response

application/json

Search response for containing all matched Konnect entities.

SearchResponse

Search response schema.

dataarray[object]

Item included in the list of search results.

Show Child Parameters
metaobject

Pagination metadata.

Show Child Parameters
get/search
 
application/json

List Search Types

Retrieves a list of searchable Konnect entity types.

get

Response

200 application/json

Search response for containing all searchable Konnect types.

SearchableEntityTypesResponse

The collection of searchable entity types.

dataarray[object]
Show Child Parameters
get/search/types
 
200 application/json

SearchCursorMeta

object

Pagination metadata.

pageobjectrequired
Show Child Parameters
Example

SearchCursorMetaPage

object
nextstring(path)

URI to the next page

sizenumberrequired

Requested page size

Example:10

Example

SearchResponse

object

Search response schema.

dataarray[object]

Item included in the list of search results.

Show Child Parameters
metaobject

Pagination metadata.

Show Child Parameters
Example