Returning.AI
  1. Returning.AI
Returning.AI
  • Returning.AI
    • Authentication
    • System
      • 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
    • Integration
      • Users
        • Create New User
        • Get User Data
        • Get Users with Filters
        • 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 Key
        • Get User Api Key
        • Post User Api Key
        • Update User Api Key
        • Delete Endpoint
        • api key info
    • Application
      • Community Users
        • Get community users
        • Get user
      • User Fields
        • Get all user fields for a community
        • Get specific user field
        • Create 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
    • 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
  1. Returning.AI

Authentication

Almost all endpoints will requrie authentication to ensure secure access.

Supported Methods#

1.
API Key : Used for system 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 integration and application 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.

Error Handling#

401 Unauthorized: Invalid or missing authentication.
403 Forbidden: Insufficient permissions for the requested action.
Modified at 2025-09-03 10:01:05
Previous
Returning.AI
Next
System