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

SearchableEntityTypesResponse

object

The collection of searchable entity types.

dataarray[object]
Show Child Parameters
Example

SearchableEntityAttributesResponse

object

Searchable attribute for the entity type.

typestringrequired

The attribute type.

Allowed values:stringnumberbooleanarray

formatstring

An optional hint at the contents and format of string types.

Allowed values:date-timeuuidemail

itemsobject

An optional hint at the type of content in array types.

Show Child Parameters
namestringrequired

The human-readable attribute name.

descriptionstringrequired

A short description of the attribute.

Example

SearchResultItem

object

Item included in the list of search results.

idstringrequired

Unique identifier for the record.

typestringrequired

Konnect entity type.

namestringrequired

Name of the entity.

descriptionstring

Description of the entity.

labelsobject

Labels for the entity.

relationsobject

Relations for the entity.

attributesobject

Attributes for the entity.

matchstring

The matched text from the record.

relations_listarray[object]

The relations tree with child and sibling relations.

Show Child Parameters
Example

Relation

object
typestringrequired

The type of the related entity.

idstringrequired

The unique identifier of the related entity.

child_relationsarray[object]required

The child relations of the related entity.

Show Child Parameters
Example