authenticated
engagements

Search Engagements

get/engagements/search

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

querystring required
cursorstring nullable
is_simulatedboolean nullable
organization_idsstring[] nullable
match'identity' | 'hybrid'
filtersstring nullable
conversation_kind'customers' | 'ask_jenny' nullable

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

search_snippetsobject
search_match_kindsobject
totalinteger nullable
cursorstring nullable
search_mode'identity' | 'hybrid'
semantic_availableboolean
limit_reachedboolean

Changes

No recorded changes to this operation across all 1 revision of this API.