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
      • 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
      • delete badge
      • remove badge from user
      • award badge to user
      • Get Tier Info
      • Get User Gamification History
      • Get User Gamification Logs
    • Streaks & Mini Games
      • 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
    • Community Analytics
      • Get Loyalty Overview

    Integration API

    The Integration API provides endpoints for connecting your community with external systems and services. These APIs are designed for scenarios where applications, bots, or third-party tools need to securely interact with your community on behalf of administrators.
    With the Integration API, you can:
    Manage users programmatically — create, update, and remove users through automation.
    Access community statistics and data — fetch analytics and performance metrics.
    Send messages and automate interactions — integrate external tools into community workflows.
    Extend platform capabilities — bridge your community with CRMs, analytics platforms, or custom backends.
    Authentication: Integration endpoints use a Bearer token, which can be generated in Community Settings. Each token comes with its own permission set, allowing fine-grained control over what an integration can or cannot do.
    Modified at 2026-03-24 09:39:51
    Previous
    Get user
    Next
    Channels
    Built with