Sign in

v68

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0170379386.9 KB
Messages

Read messages

Retrieves list of messages from messaging/chat datasources (e.g. Slack, Teams).

post/rest/api/v1/messages

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Headers

X-Glean-ActAsstring email

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

X-Glean-Auth-Typestring

Auth type being used to access the endpoint (should be non-empty only for global tokens).

Request body

idType'CHANNEL_NAME' | 'THREAD_ID' | 'CONVERSATION_ID' required

Type of the id in the incoming request.

idstring required

ID corresponding to the requested idType. Note that channel and threads are represented by the underlying datasource's ID and conversations are represented by their document's ID.

workspaceIdstring

Id for the for the workspace in case of multiple workspaces.

direction'OLDER' | 'NEWER'

The direction of the results asked with respect to the reference timestamp. Missing field defaults to OLDER. Only applicable when using a message_id.

timestampMillisinteger

Timestamp in millis of the reference message. Only applicable when using a message_id.

includeRootMessageboolean

Whether to include root message in response.

datasource'SLACK' | 'SLACKENTGRID' | 'MICROSOFTTEAMS' | 'GCHAT' | 'FACEBOOKWORKPLACE' required

The type of the data source.

datasourceInstanceDisplayNamestring

The datasource instance display name from which the document was extracted. This is used for appinstance facet filter for datasources that support multiple instances.

Response

OK

hasMoreboolean required

Whether there are more results for client to continue requesting.

Example response

{
  "searchResponse": {
    "trackingToken": "trackingToken",
    "suggestedSpellCorrectedQuery": "suggestedSpellCorrectedQuery",
    "hasMoreResults": true,
    "errorInfo": {
      "errorMessages": [
        {
          "source": "gmail",
          "errorMessage": "invalid token"
        },
        {
          "source": "slack",
          "errorMessage": "expired token"
        }
      ]
    },
    "requestID": "5e345ae500ff0befa2b9d1a3ba0001737e7363696f312d323535323137000171756572792d656e64706f696e743a323032303031333074313830343032000100",
    "results": [
      {
        "snippets": [
          {
            "snippet": "snippet",
            "mimeType": "mimeType"
          }
        ],
        "metadata": {
          "container": "container",
          "createTime": "2000-01-23T04:56:07.000Z",
          "datasource": "datasource",
          "author": {
            "name": "name"
          },
          "documentId": "documentId",
          "updateTime": "2000-01-23T04:56:07.000Z",
          "mimeType": "mimeType",
          "objectType": "objectType"
        },
        "title": "title",
        "url": "https://www.example.com/"
      },
      {
        "snippets": [
          {
            "snippet": "snippet",
            "mimeType": "mimeType"
          }
        ],
        "metadata": {
          "container": "container",
          "createTime": "2000-01-23T04:56:07.000Z",
          "datasource": "datasource",
          "author": {
            "name": "name"
          },
          "documentId": "documentId",
          "updateTime": "2000-01-23T04:56:07.000Z",
          "mimeType": "mimeType",
          "objectType": "objectType"
        },
        "title": "title",
        "url": "https://www.example.com/"
      }
    ],
    "facetResults": [
      {
        "buckets": [
          {
            "percentage": 5,
            "count": 1,
            "value": {
              "stringValue": "stringValue",
              "integerValue": 5
            }
          },
          {
            "percentage": 5,
            "count": 1,
            "value": {
              "stringValue": "stringValue",
              "integerValue": 5
            }
          }
        ],
        "sourceName": "sourceName",
        "operatorName": "operatorName",
        "objectType": "objectType"
      },
      {
        "buckets": [
          {
            "percentage": 5,
            "count": 1,
            "value": {
              "stringValue": "stringValue",
              "integerValue": 5
            }
          },
          {
            "percentage": 5,
            "count": 1,
            "value": {
              "stringValue": "stringValue",
              "integerValue": 5
            }
          }
        ],
        "sourceName": "sourceName",
        "operatorName": "operatorName",
        "objectType": "objectType"
      }
    ],
    "rewrittenQuery": "rewrittenQuery",
    "rewrittenFacetFilters": [
      {
        "fieldName": "fieldName",
        "values": [
          "fieldValues",
          "fieldValues"
        ]
      },
      {
        "fieldName": "fieldName",
        "values": [
          "fieldValues",
          "fieldValues"
        ]
      }
    ]
  },
  "rootMessage": {
    "snippets": [
      {
        "snippet": "snippet",
        "mimeType": "mimeType"
      }
    ],
    "metadata": {
      "container": "container",
      "createTime": "2000-01-23T04:56:07.000Z",
      "datasource": "datasource",
      "author": {
        "name": "name"
      },
      "documentId": "documentId",
      "updateTime": "2000-01-23T04:56:07.000Z",
      "mimeType": "mimeType",
      "objectType": "objectType"
    },
    "title": "title",
    "url": "https://example.com/foo/bar",
    "nativeAppUrl": "slack://foo/bar",
    "mustIncludeSuggestions": [
      {
        "missingTerm": "container",
        "query": "container"
      }
    ]
  }
}