Returning.AI
  1. APIs
Returning.AI
  • Returning.AI
    • APIs
      • Authentication
      • System API
        • Auth
          • Secure Auth
          • register
          • verify email
          • login
        • Server
          • create new server
          • get my servers
          • update server
          • channel list of server
        • Channel
          • get channels list
          • create new channel
          • update channel
          • delete channel
        • Role
          • role list of server
          • create new role
          • update role
          • delete role
          • get role list of user on a server
          • add role to a user on a server
          • remove role from a 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 Custom User Field
          • Delete Custom 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 Key
          • Integration Api Key Info
          • Get Integration Api Key
          • Post Integration Api Key
          • Delete Integration Api Key
          • Update Integration Api Key
          • Login API
      • 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
          • Get All Bulk Update
          • Check Bulk Update Status
          • Check Bulk Update Details
        • Messages
          • Get Messages
          • Send Message
          • Reply Message
          • React Message
        • Channels
          • Get Channels List
        • Xp Settings
          • Get Tier Info
      • User API
        • API key
          • Update User Api Key
          • api key info
          • Delete Endpoint
          • Get User Api Key
          • Post User Api Key
        • 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
      • Authenticated Widgets
      • Public widgets
    • Features
  1. APIs

Authentication

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 2025-09-11 08:23:03
Previous
APIs
Next
System API