Get Messages

This endpoint returns the message history of users in the community.

Authorization

Bearer token Required
Found in the platform under community settings >** API keys.**
Permission: Get Messages

Parameters

This endpoints allow filtering base on the user, channel and number of messages.

Users

Use the user ID or email to filter the needed user. The response will include the messages send by the provided user in all channels.

Include only one user parameters, do not use both user ID and email

Without any User parameter, the response will return for all users in the community

Channel

Use the channel ID to filter for the required channel. The response will include the messages send in the provided channel by all users.

Without any channel parameter, the response will return for all channels in the community

Use both User and channel parameter to get messages send by a particular user in a selected channel.

Count

Use the count to filter for the number of messages returned. (Acceted value: 1 - 100)
The response will contain the number of messages in the count.

Without any count parameter, the response will return the last 50 messages send.

Responses

🟢200Success

application/json

Body

Example

{
    "status": "success",
    "message": "messages fetched successfully",
    "data": {
        "total": 10,
        "messages": [
            {
                "id": "689b908502ad38f",
                "message": "Hi",
                "user": {
                    "user_id": "1243",
                    "email": "johndoe@gmail.com"
                },
                "channel": {
                    "channel_id": "663347f4361726479c6",
                    "name": "Rules"
                },
                "timestamp": "2025-08-05T01:39:43.561Z"
            },
         ...
            {
                "id": "6633473f8a0f479cf",
                "message": "Good morning everyone!",
                "user": {
                    "user_id": "1243",
                    "email": "johndoe@gmail.com"
                },
                "channel": {
                    "channel_id": "66334714361726479c6",
                    "name": "General"
                },
                "timestamp": "2024-05-02T07:56:47.276Z"
            }
        ]
    }
}

🟠401Insufficient permission

🟠401Invalid token

🟠404Record Not Found

Authorization

Parameters

Users

Channel

Count

Request

Request Code Samples

Responses

Get Messages

Authorization#

Parameters#

Users#

Channel#

Count#

Request

Request Code Samples

Responses

Authorization

Parameters

Users

Channel

Count