1. Community Users
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 channels list
    • create new channel
    • update channel
    • delete channel
    • Get Channels List
  • 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
      • Get user
        GET
  • 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
  1. Community Users

Get user

GET
/apis/v1/communities/{communityId}/users/{userId}
Retrieve user information by user ID within a community context with optional field selection.
Security Requirements:
Bearer token authentication required
User must have COMMUNITY_MEMBER or COMMUNITY_OWNER or COMMUNITY_ADMIN permission for the specified community
User must be a community member, owner, or administrator to access other users' information
Community members can access information of other community members but some fields are protected

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://application-sgtr.returning.ai/apis/v1/communities//users/?_id&id&avatar&displayName&username&firstName&lastName&email&isOnline&lastLogin' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK
application/json
Get user successful
Body

Example
{
    "meta": {
        "status": "success",
        "statusCode": 200
    },
    "message": "Get user success.",
    "data": {
        "_id": "61100af5c548eb5c7ebc7819",
        "id": 123456789,
        "avatar": "https://returning-ai.com/avatar.png",
        "displayName": "Admin",
        "username": "admin",
        "firstName": "John",
        "lastName": "Doe",
        "email": "admin@example.com",
        "isOnline": true,
        "lastLogin": "2023-12-01T10:30:00Z"
    }
}
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Modified at 2025-08-28 10:33:56
Previous
Get community users
Next
Integration API