Performs a conversation search

v1.0.0

Performs a search for conversation content. A maximum of 100 conversations is returned. If you hit this limit you should refine the search term. OauthScopes: READ_CONVERSATIONS

Input

{
  "type": "object",
  "properties": {
    "includeItemIds": {
      "type": "boolean"
    },
    "scope": {
      "type": "string",
      "enum": [
        "FILES",
        "PEOPLE",
        "MEMBERS",
        "MESSAGES",
        "SENTBY",
        "ALL",
        "CONVERSATIONS",
        "LABEL",
        "FILTER"
      ]
    },
    "term": {
      "type": "string"
    }
  },
  "required": [
    "term"
  ],
  "additionalProperties": false
}

Output

{
  "properties": {
    "matchingConversations": {
      "type": "array",
      "description": "A list of result items for conversations that match the search term.",
      "items": {
        "properties": {
          "convId": {
            "type": "string",
            "description": "The ID of the conversation to which the matching items belong."
          },
          "itemIds": {
            "type": "array",
            "description": "The conversation items which contain the search result. The list maybe empty in case a hit was found for the conversation related data like topic or participants.",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}