1. User Data
Returning.AI
  • 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
    • Get all mini game logs by user email
      POST
    • Get user's current Mini Games and Streak stats
      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
    • delete badge
    • remove badge from user
    • award badge to user
    • Get Tier Info
    • Get User Gamification History
    • Get User Gamification Logs
  • Streaks & Mini Games
    • Get Streak Logs
  • Rewards & Redemptions
    • Update redemption transaction status
    • Get all redemption transactions by user email
    • Get All Redemption Statuses
    • Get Redemption Status by ID
    • Get all redemption transactions by Community
    • Create Redemption Status
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk Import
    • Get All Bulk Update
    • Check Bulk Update Status
    • Check Bulk Update Details
    • Bulk Update
    • Premium Currency Bulk Update
  • Application API
    • Community Users
      • Get community users
      • Get user
  • Integration API
  • 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
  • Community Analytics
    • Get Loyalty Overview
  1. User Data

Get user field histories for a specific field

GET
/v1/communities/{communityId}/user-fields/{fieldIdOrName}/histories
Retrieve all user field history records for a specific field within a community.
This endpoint returns user details for each history entry but omits field information since the field is specified in the path.
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

Request

Path Params

Query Params

Responses

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

🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://sgtr-api.returning.ai/v1/communities/507f1f77bcf86cd799439011/user-fields/507f1f77bcf86cd799439013/histories?page=1&limit=10'
Response Response Example
200 - Success
{
    "meta": {
        "status": "success",
        "statusCode": 200,
        "total": 32,
        "page": 1,
        "limit": 10
    },
    "message": "Get user field histories",
    "data": [
        {
            "_id": "685a48f5cbfa3985ad581bae",
            "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",
            "user": {
                "_id": "507f1f77bcf86cd799439013",
                "id": 12346,
                "avatar": null,
                "displayName": "Jane Smith",
                "username": "janesmith"
            },
            "value": 250,
            "action": "increase",
            "createdAt": "2025-06-23T13:30:15.123Z"
        }
    ]
}
Modified at 2026-04-07 08:39:29
Previous
Get all user field histories in a community
Next
Get user field histories for a specific user
Built with