Returning.AI
  1. Returning.AI
Returning.AI
  • Returning.AI
    • APIs
      • Authentication
      • System API
        • Auth
          • Secure Auth
          • register
          • verify email
          • login
        • Server
          • create new server
          • get my servers
          • update server
          • role list of server
          • channel list of server
        • Channel
          • get channels list
          • create new channel
          • update channel
          • delete channel
        • Role
          • create new role
          • update role
          • delete role
          • add role to a user on a server
          • remove role from a user on a server
          • get role list of user on a server
        • Badge
          • get badges list
          • create new badge
          • update badge
          • delete badge
          • award badge to user
          • remove badge from user
      • Application API
        • Community Users
          • Get community users
          • Get user
        • User Fields
          • Get All User Fields
          • Get specific user field
          • Create Custom User Field
          • Update user field
          • Delete user field
        • User Field Histories
          • 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
      • Integration API
        • Users
          • Get Users with Filters
          • Create New User
          • Get User Data
          • Manage User Account
          • Get User Gamification History
          • Get User Gamification Stats
          • Bulk Import
          • Bulk Update
        • Messages
          • Send Message
          • Reply Message
          • React Message
        • Channels
          • Get Channels List
      • User API
        • API key
          • api key info
          • Get User Api Key
          • Post User Api Key
          • Update User Api Key
          • Delete Endpoint
        • Messages
          • Send Message
          • Reply Message
          • React Message
    • 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
      • Channels
      • Leaderboard
      • Milestone
      • Socials
      • Store
  1. Returning.AI

APIs

The platform APIs let you extend, integrate, and customize your community, there are different API types designed for different purposes, each with their own authentication method, scope of access and intended use cases.
1.
System API
Authentication: Community-level API key (one per community)
Scope: Core system operations.
Use cases:
Secure Authentication flows
Manager server level items
Channels
Role
Badges
2.
Application API
Authentication: Bearer token from Community Settings, with role-based permissions.
Scope: Application-level customization and extensions.
Use cases:
Managing custom fields
Application-specific data operations
3.
Integration API
Authentication: Bearer token from Community Settings, with role-based permissions.
Scope: Integrations that connect external systems to your community.
Use cases:
Creating users
Get user specific datas
Bulk import/ updates
Send messages
4.
User API
Authentication: API key from each user’s profile (no admin required).
Scope: Actions a regular authenticated user can perform on their own behalf.
Use cases:
Sending messages as the user

Choosing the Right API#

Use System API for core community/system-level tasks.
Use Application API for application-specific extensions and configurations.
Use Integration API when building external integrations with scoped permissions.
Use User API when you want to let end-users interact with the platform directly using their personal API key.
Modified at 2025-09-11 09:18:11
Previous
Returning.AI
Next
Authentication