Unleash Search API

Search for resources using a query and filters

04 Oct 2024
6 Minutes to read
Contributors

Print
Share
Dark
Light

Search for resources using a query and filters

Updated on 04 Oct 2024
6 Minutes to read
Contributors

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/search

Security

API Key

Header parameter nameAuthorization

Enter the token with the Bearer: prefix, e.g. "Bearer abcde12345".

Header parameters

unleash-account

Impersnoation header

Body parameters

Expand All

object

assistantId

string | null

filters

object (Requests.SearchFilters)

resourceId

Array of string | null

string

isStarred

boolean | null

hasAttachments

boolean | null

rsvp

Array of string | null

string

appId

Array of string | null

string

type

Array of string | null

string

label

Array of string | null

string

anyLabel

Array of string | null

string

sentTo

Array of string | null

string

sentFrom

Array of string | null

string

createdBy

Array of string | null

string

modifiedBy

Array of string | null

string

reporter

Array of string | null

string

assignedTo

Array of string | null

string

reviewer

Array of string | null

string

fromTime

string | null

untilTime

string | null

createBeforeTime

string | null

createAfterTime

string | null

modifiedBeforeTime

string | null

modifiedAfterTime

string | null

dueBeforeTime

string | null

dueAfterTime

string | null

class

Array of string | null

string

sharedBy

Array of string | null

string

sharedWith

Array of string | null

string

linkId

Array of string | null

string

eventTimeFrameStart

string | null

eventTimeFrameEnd

string | null

status

Array of string | null

string

cycle

Array of string | null

string

extension

Array of string | null

string

jobTitle

Array of string | null

string

location

Array of string | null

string

department

Array of string | null

string

managedBy

Array of string | null

string

isManager

boolean | null

participants

Array of string | null

string

topic

Array of string | null

string

hasLinks

boolean | null

mentioned

Array of string | null

string

pathPrefix

Array of string | null

string

path

Array of string | null

string

fileTypeGroup

Array of string | null

string

relatedContacts

Array of string | null

string

recentActivityFor

string | null

workingOn

string | null

property*

query

string | null

contentSearch

boolean

semanticSearch

boolean

Whether to use an AI search in additional to full-text search

Defaulttrue

sort

object (SearchSortRequest)

string

Valid values[ "\"Relevancy\"", "\"Alphabetical\"", "\"Recency\"" ]

order

string

Valid values[ "\"Ascending\"", "\"Descending\"" ]

paging

object (Requests.SearchPagingRequest)

nextToken

string | null

size

integer (int32) | null

Expand All

object

assistantId

string | null

filters

object (Requests.SearchFilters)

resourceId

Array of string | null

string

isStarred

boolean | null

hasAttachments

boolean | null

rsvp

Array of string | null

string

appId

Array of string | null

string

type

Array of string | null

string

label

Array of string | null

string

anyLabel

Array of string | null

string

sentTo

Array of string | null

string

sentFrom

Array of string | null

string

createdBy

Array of string | null

string

modifiedBy

Array of string | null

string

reporter

Array of string | null

string

assignedTo

Array of string | null

string

reviewer

Array of string | null

string

fromTime

string | null

untilTime

string | null

createBeforeTime

string | null

createAfterTime

string | null

modifiedBeforeTime

string | null

modifiedAfterTime

string | null

dueBeforeTime

string | null

dueAfterTime

string | null

class

Array of string | null

string

sharedBy

Array of string | null

string

sharedWith

Array of string | null

string

linkId

Array of string | null

string

eventTimeFrameStart

string | null

eventTimeFrameEnd

string | null

status

Array of string | null

string

cycle

Array of string | null

string

extension

Array of string | null

string

jobTitle

Array of string | null

string

location

Array of string | null

string

department

Array of string | null

string

managedBy

Array of string | null

string

isManager

boolean | null

participants

Array of string | null

string

topic

Array of string | null

string

hasLinks

boolean | null

mentioned

Array of string | null

string

pathPrefix

Array of string | null

string

path

Array of string | null

string

fileTypeGroup

Array of string | null

string

relatedContacts

Array of string | null

string

recentActivityFor

string | null

workingOn

string | null

property*

query

string | null

contentSearch

boolean

semanticSearch

boolean

Whether to use an AI search in additional to full-text search

Defaulttrue

sort

object (SearchSortRequest)

string

Valid values[ "\"Relevancy\"", "\"Alphabetical\"", "\"Recency\"" ]

order

string

Valid values[ "\"Ascending\"", "\"Descending\"" ]

paging

object (Requests.SearchPagingRequest)

nextToken

string | null

size

integer (int32) | null

Expand All

object

assistantId

string | null

filters

object (Requests.SearchFilters)

resourceId

Array of string | null

string

isStarred

boolean | null

hasAttachments

boolean | null

rsvp

Array of string | null

string

appId

Array of string | null

string

type

Array of string | null

string

label

Array of string | null

string

anyLabel

Array of string | null

string

sentTo

Array of string | null

string

sentFrom

Array of string | null

string

createdBy

Array of string | null

string

modifiedBy

Array of string | null

string

reporter

Array of string | null

string

assignedTo

Array of string | null

string

reviewer

Array of string | null

string

fromTime

string | null

untilTime

string | null

createBeforeTime

string | null

createAfterTime

string | null

modifiedBeforeTime

string | null

modifiedAfterTime

string | null

dueBeforeTime

string | null

dueAfterTime

string | null

class

Array of string | null

string

sharedBy

Array of string | null

string

sharedWith

Array of string | null

string

linkId

Array of string | null

string

eventTimeFrameStart

string | null

eventTimeFrameEnd

string | null

status

Array of string | null

string

cycle

Array of string | null

string

extension

Array of string | null

string

jobTitle

Array of string | null

string

location

Array of string | null

string

department

Array of string | null

string

managedBy

Array of string | null

string

isManager

boolean | null

participants

Array of string | null

string

topic

Array of string | null

string

hasLinks

boolean | null

mentioned

Array of string | null

string

pathPrefix

Array of string | null

string

path

Array of string | null

string

fileTypeGroup

Array of string | null

string

relatedContacts

Array of string | null

string

recentActivityFor

string | null

workingOn

string | null

property*

query

string | null

contentSearch

boolean

semanticSearch

boolean

Whether to use an AI search in additional to full-text search

Defaulttrue

sort

object (SearchSortRequest)

string

Valid values[ "\"Relevancy\"", "\"Alphabetical\"", "\"Recency\"" ]

order

string

Valid values[ "\"Ascending\"", "\"Descending\"" ]

paging

object (Requests.SearchPagingRequest)

nextToken

string | null

size

integer (int32) | null

Responses

200

Success

Expand All

object

totalResults

integer (int64)

results

Array of object (Responses.SearchResponseItem) | null

object

resource

object (Responses.Resource)

string | null

appId

string | null

type

string | null

externalId

string | null

name

string | null

data

object | null

property*

snippet

string | null

highlights

Array of string | null

string

paging

object (Responses.SearchPagingResponse)

string | null

requestId

string | null

400

Bad Request

Expand All

object

type

string | null

title

string | null

status

integer (int32) | null

detail

string | null

instance

string | null

errors

object | null

property*

Array of string additionalProperties

string

property*

Was this article helpful?

What's Next

Answer questions