1. Messaging
Returning.AI
  • Getting Started
  • Authentication
    • Secure Auth
      GET
    • register
      POST
    • verify email
      POST
    • login
      POST
  • Users
    • Get user
      GET
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data
      POST
    • Manage User Account
      POST
    • Get User Gamification Stats
      POST
    • Get all mini game logs by user email
      POST
    • Get user's current Mini Games and Streak stats
      POST
  • Roles & Permissions
    • role list of server
      GET
    • create new role
      POST
    • update role
      PUT
    • delete role
      DELETE
    • get role list of user on a server
      GET
    • add role to a user on a server
      POST
    • remove role from a user on a server
      POST
  • Servers
    • create new server
      POST
    • get my servers
      GET
    • update server
      PUT
  • Channels
    • channel list of server
    • get channels list
    • create new channel
    • update channel
    • delete channel
    • Get Channels List
  • Messaging
    • Get Messages
      GET
    • Send Message
      POST
    • Reply Message
      POST
    • React Message
      POST
    • Upload Image
      POST
  • User Data
    • Get All User Fields
    • Get Specific User Field
    • Create Custom User Field
    • Update Custom User Field
    • Delete Custom User Field
    • Get all user field histories in a community
    • Get user field histories for a specific field
    • Get user field histories for a specific user
    • Get user field histories of specific user field and user
    • Create user field history for specific user
  • Gamification
    • get badges list
    • create new badge
    • update badge
    • delete badge
    • remove badge from user
    • award badge to user
    • Get Tier Info
    • Get User Gamification History
    • Get User Gamification Logs
  • Streaks & Mini Games
    • Streak Logs
      • Get Streak Logs
  • Rewards & Redemptions
    • Update redemption transaction status
    • Get all redemption transactions by user email
    • Get All Redemption Statuses
    • Get Redemption Status by ID
    • Get all redemption transactions by Community
    • Create Redemption Status
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk Import
    • Get All Bulk Update
    • Check Bulk Update Status
    • Check Bulk Update Details
    • Bulk Update
    • Premium Currency Bulk Update
  • Application API
    • Community Users
      • Get community users
      • Get user
  • Integration API
  • Channels
    • Iframe
  • Events
    • Outgoing webhooks
      • Encryption
      • User Joins Server
      • User Visits server
      • New Message Posted Anywhere
      • New Message Posted To channel
      • Purchased Store Item
    • Incoming webhooks
      • API Keys & Encryption
      • Send message into channels
      • Update Custom User Fields
      • Update In-game currency
  • Widgets
    • Authenticated Widgets
    • Public widgets
  • Features
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
    • Schemas
      • ValidationError
      • NotFoundError
      • InternalServerError
      • NotImplementedError
      • CreateUserFieldHistoryResponse
      • CreateUserFieldHistorySuccessResponse
      • UserFieldHistoryItem
      • GetUserFieldHistoriesResponse
      • UserFieldHistoriesValidationError
      • UserFieldHistoriesMetaWithValidation
      • UserFieldHistoriesMetaWithPagination
      • GetUserFieldHistoriesSuccessResponse
      • CreateUserFieldResponse
      • CreateUserFieldSuccessResponse
      • DeleteUserFieldResponse
      • DeleteUserFieldSuccessResponse
      • UserFieldCreator
      • GetUserFieldResponse
      • GetUserFieldSuccessResponse
      • ValidationErrorItem
      • GetUserFieldsMetaResponse
      • CreatorInfo
      • UserFieldResponse
      • GetUserFieldsSuccessResponse
      • UpdateUserFieldResponse
      • UpdateUserFieldPayload
      • UpdateUserFieldSuccessResponse
      • MetaResponse
      • GetUserResponse
      • GetUserSuccessResponse
    • Outgoing webhooks
      • Purchased store item
      • New message posted to channel
      • User visits server
      • User join server
      • ErrorResponse
    • Analysis
      • UpdateAnalysisRequest
      • AppendDrawingsRequest
      • CreateAnalysisResponse
      • GetAnalysisResponse
      • UpdateAnalysisResponse
      • AppendDrawingsResponse
      • AnalysisMetadata
      • Expiry
      • Levels
      • LevelEntry
      • Drawing
      • HorizontalLineDrawing
      • LineDrawing
      • RectangleDrawing
      • ParallelDrawing
      • FibonacciRetracementDrawing
      • Coordinate
      • DrawingStyle
      • AnalysisDetail
      • AnalysisSummary
      • CreateAnalysisRequest
      • ListAnalysesResponse
  1. Messaging

Get Messages

GET
/v1/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.

Request

Query Params

Responses

🟢200Success
application/json
Body

🟠401Insufficient permission
🟠401Invalid token
🟠404Record Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.returning.ai/v1/messages?user_id&channel_id&count&email'
Response Response Example
200 - Success
{
    "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"
            }
        ]
    }
}
Modified at 2026-04-07 08:36:22
Previous
Get Channels List
Next
Send Message
Built with