Rivier/ Reference/ inbox

A search written back in words, with the parts that were not understood

get/workspace/inbox/search/explain

Before you call

Credential
Authorization: Bearer $KEY
Scope
inbox:read
Graphql
Query.inboxDeskExplain
Sdk
inbox.desk.explain
Cli
inbox desk explain

Parameters

  • qstringrequired
    In the query

Responses

  • 200application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown