Returning.AI-dev-wip
    • 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
      • Upload User Avatar
        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
      • get channels list
        GET
      • create new channel
        POST
      • update channel
        PUT
      • delete channel
        DELETE
      • Get Channels List
        GET
    • Messaging
      • Get Messages
      • Send Message
      • Reply Message
      • React Message
      • Upload Image
    • 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
      • award badge to user
      • delete badge
      • remove badge from user
      • Get Tier Info
      • Get User Gamification History
      • Get User Gamification Logs
    • Streaks & Mini Games
      • Get Streak Logs
      • Get all mini game logs by user email
      • Get user's current Mini Games and Streak stats
      • Update user wheel info (spins and/or streaks) by email
    • Rewards & Redemptions
      • Update redemption transaction status
      • Get all redemption transactions by user email
      • Get All Redemption Statuses
      • Get Redemption Status by ID
      • Create Redemption Status
      • Get all redemption transactions by Community
      • Get Redemption Transaction History
    • Chart Analysis
      • Create Analysis
      • Get Analysis
      • Update Analysis
      • List Analyses
      • Append Drawings
      • Delete Analysis
    • Bulk Operations
      • Check Bulk Update Details
      • Check Bulk Update Status
      • Premium Currency Bulk Update
      • Get All Bulk Update
      • Bulk Update
      • Bulk Import
    • Application API
      • Community Users
        • Get community users
        • Get user
    • Integration API
      • Community Analytics
        • Get Loyalty Overview
      • Streaks
        • Update Streak Settings
        • Get All Streaks
        • Create Streak
        • Update Streak
        • Delete Streak
    • Channels
      • Iframe
    • Widgets
      • Authenticated Widgets
      • Public widgets
    • 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
    • Features

    Getting Started

    Almost all endpoints will requrie authentication to ensure secure access.

    Supported Methods#

    1.
    API Key : Used for system API endpoints. Include an X-API-Key header with the key.
    Key is found in community settings > Login Management > API key
    image.png
    Each community has only one such key, which grants full permissions for all system endpoints.
    2.
    Bearer token: Used for Application and Intergration API endpoints. Include an Authorization header with the format Bearer YOUR_TOKEN.
    Token is found in community settings > Integration > API key
    image.png
    API keys must be created by admins. Each key can have unique permissions and an expiration date.
    Individual endpoints require specific permissions, which are documented in their respective sections.
    3.
    User API key: Used for User Api endpoints.
    Include an Authorization header with the format Bearer YOUR_TOKEN.
    Token is found in user prefernces > API keys

    Error Handling#

    401: Insufficient permissions for the requested action/ Invalid token.
    Modified at 2026-04-09 08:22:10
    Next
    Secure Auth