1. User Data
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
    • get my servers
    • update server
  • 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
    • Get Specific User Field
      GET
    • Create Custom User Field
      POST
    • Update Custom User Field
      PUT
    • Delete Custom User Field
      DELETE
    • Get all user field histories in a community
      GET
    • Get user field histories for a specific field
      GET
    • Get user field histories for a specific user
      GET
    • Get user field histories of specific user field and user
      GET
    • Create user field history for specific user
      POST
  • 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 user
  • 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. User Data

Get all user field histories in a community

GET
/apis/v1/communities/{communityId}/user-field-histories
Retrieve all user field history records within a community with full user and field details.
This endpoint returns comprehensive information including user profiles and field metadata for each history entry.
Security Requirements:
Bearer token authentication required
Only community owners and administrators can access this endpoint
User must have either COMMUNITY_OWNER or COMMUNITY_ADMIN permissions for the specified community
Community API key with userFields permission can also be used

Request

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://sgtr-rai-api.returning.ai/api/v1/apis/v1/communities/507f1f77bcf86cd799439011/user-field-histories?page=1&limit=10'

Responses

🟢200OK
application/json
Get all user field histories successful
Body

Example
{
    "meta": {
        "status": "success",
        "statusCode": 200,
        "total": 125,
        "page": 1,
        "limit": 10
    },
    "message": "Get user field histories",
    "data": [
        {
            "_id": "685a48f5cbfa3985ad581bae",
            "field": {
                "_id": "6857de260f3c24d98fd7ca89",
                "field": "hello",
                "name": "Hello",
                "type": "numerical",
                "isCustom": true,
                "createdAt": "2025-06-22T10:42:32.844Z",
                "updatedAt": "2025-06-22T10:42:32.844Z"
            },
            "user": {
                "_id": "61100af5c548eb5c7ebc7819",
                "id": 1,
                "avatar": "https://returning.ai/admin.png",
                "displayName": "Admin",
                "username": "admin"
            },
            "value": 500,
            "action": "overwrite",
            "createdAt": "2025-06-24T06:43:01.078Z"
        },
        {
            "_id": "685957701ff244c62bd2e5b5",
            "field": {
                "_id": "6857de260f3c24d98fd7ca90",
                "field": "xp",
                "name": "Experience Points",
                "type": "number",
                "isCustom": true,
                "createdAt": "2025-06-20T11:20:45.000Z",
                "updatedAt": "2025-06-20T11:20:45.000Z"
            },
            "user": {
                "_id": "507f1f77bcf86cd799439013",
                "id": 12346,
                "avatar": null,
                "displayName": "Jane Smith",
                "username": "janesmith"
            },
            "value": 50,
            "action": "increase",
            "createdAt": "2025-06-23T13:30:15.123Z"
        }
    ]
}
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Modified at 2026-04-09 08:33:06
Previous
Delete Custom User Field
Next
Get user field histories for a specific field