Find messages by query

Get messages by query with support for filtering, sorting, and pagination.

Filtering:

• Filter by ticket: ticket=507f1f77bcf86cd799439011
• Filter by type: type=COMMENT or type=COMMENT,NOTE
• Filter by bot messages: bot=true or bot=false
• Filter by date range: createdAt>=2024-01-01&createdAt<=2024-12-31

Sorting:

• Sort by creation date: sort=-createdAt (newest first) or sort=createdAt (oldest first)
• Sort by updated date: sort=-updatedAt

Pagination:

• Limit results: limit=50 (default up to 10000)
• Skip results: skip=0 (for pagination: skip=(page-1)*limit)

Translation:

• Auto-translate messages: language=es (language code for target language)

GET /messages

Find messages by query

cURL

curl --request GET \
  --url https://api.gleap.io/v3/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>'

200

[
  {
    "_id": "507f1f77bcf86cd799439015",
    "id": "507f1f77bcf86cd799439015",
    "ticket": "507f1f77bcf86cd799439011",
    "comment": {
      "type": "doc",
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "type": "text",
              "text": "This is a sample message content."
            }
          ]
        }
      ]
    },
    "type": "COMMENT",
    "bot": false,
    "user": {
      "_id": "507f1f77bcf86cd799439012",
      "email": "[e-mail]",
      "firstName": "John",
      "lastName": "Doe"
    },
    "session": {
      "_id": "507f1f77bcf86cd799439013",
      "email": "[e-mail]"
    },
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "index": 0
  },
  {
    "_id": "507f1f77bcf86cd799439016",
    "id": "507f1f77bcf86cd799439016",
    "ticket": "507f1f77bcf86cd799439011",
    "comment": {
      "type": "doc",
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "type": "text",
              "text": "Thank you for the update!"
            }
          ]
        }
      ]
    },
    "type": "COMMENT",
    "bot": false,
    "user": {
      "_id": "507f1f77bcf86cd799439017",
      "email": "[e-mail]",
      "firstName": "Jane",
      "lastName": "Smith"
    },
    "session": {
      "_id": "507f1f77bcf86cd799439013",
      "email": "[e-mail]"
    },
    "createdAt": "2024-01-15T11:00:00.000Z",
    "updatedAt": "2024-01-15T11:00:00.000Z",
    "index": 1
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

project · string · required

Query Parameters

paginated · boolean

before · string

limit · number<double>

• Maximum number of messages to return (default: no limit, max: 10000)

showHistory · boolean

Response

200 - application/json

Ok