1. User Field History
Returning.AI
  • Getting Started
  • Users
    • User directory and provisioning
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data
      POST
    • Manage User Account
      POST
    • Get User Milestones
      POST
    • Update User Data, Identifier, And Roles
      POST
    • Update User XP and Currency
      POST
  • Messaging
    • Agent messaging workflow
    • Get Messages
      GET
    • Send Message
      POST
    • Reply Message
      POST
    • React Message
      POST
    • Upload message images
      POST
  • Gamification
    • Leaderboards
      • Leaderboards
      • List leaderboards with pagination
      • Create a new leaderboard
      • Update an existing leaderboard
      • Get a single leaderboard by ID
      • Delete a leaderboard
    • Streaks & Mini Games
      • Mini-game State and History
      • List user streak logs
      • List mini-game logs by user email
      • Get current mini-game and streak state
      • Update user spin-wheel information
    • Referral
      • Referral Program Integration
      • Get referral programs
      • Get user's referral summary
    • Rolling Data
      • Get Daily Calculation Data
      • Get Rolling Calculation Data
    • Match Predictions
    • Get tier configuration
    • Get daily user XP and coin changes
    • Search user gamification logs
    • Get user activity stats
  • Rewards & Redemptions
    • Store catalog to redemptions
    • Update redemption order status or refund
    • List redemption orders by user email
    • List redemption statuses
    • Get redemption status by ID
    • List redemption orders by community
    • Create redemption order status
    • Get redemption order status history
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk user updates
    • List bulk update jobs
    • Get bulk update job status
    • Get bulk update job details
    • Bulk update users from CSV
    • Bulk update premium currency from CSV
  • Channels
    • Iframe
    • List integration channels
  • 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
    • Channels
    • Leaderboard
    • Milestone
    • Socials
    • Store
  • Community Analytics
    • Get Loyalty Overview
    • Get Phone Verification Contacts
  • Store
    • Store catalog
    • Purchase History
      • Update redemption instructions or voucher details
    • Categories
      • List Store categories
      • Create Store category
      • Get Store category by ID
      • Update Store category
      • Delete Store category
    • Products
      • List products
      • Update products in bulk
      • Create products in bulk
      • Create product with vouchers
      • Read product
      • Update product and append vouchers
      • Delete product
    • Redemption-transaction
      • Get redemption transaction detail
    • Get Store configuration
    • Update Store configuration
  • Community
    • Community directory and appearance
    • Appearance
      • Update community theme colors
      • Update community bot profile
      • Update community URL metadata
      • Update community name and URL
    • Community Users
      • Get community users
      • Get user
    • Create community
  • API Keys
    • API key lifecycle
    • Community API Keys
      • Create API key
      • Read API keys
      • Delete API key
      • Update API key
    • User API Keys
      • List user API keys
      • Create user API key
      • Update user API key
      • Delete user API key
      • Get current API key information
  • User Fields
    • User field definitions and history
    • User Field History
      • 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
      • Update A User Field Value
        POST
      • Deprecated Field-First History Write
        POST
      • Deprecated Field-First History Read
        GET
    • Get A User Field Definition
      GET
    • Update A User Field Definition
      PUT
    • Create A User Field Definition
      POST
    • Delete A User Field Definition
      DELETE
    • List User Field Definitions
      GET
  • Legacy
    • Servers
      • Create server
      • List servers
      • Update server metadata
    • Bulk Operations
      • Bulk import users from CSV
    • Authentication
      • Secure Auth
      • Register user with password
      • Verify user email
      • Log in user with password
    • Badges
      • List badges
      • Create badge
      • Update badge
      • Delete badge
      • Remove badge from user
      • Award badge to user
    • Messaging
    • Roles & Permissions
      • List server roles
      • Create role
      • Update role
      • Delete role
      • List user roles
      • Add role to user
      • Remove role from user
    • Users
      • Get user
      • Upload user avatar
    • Channels
      • Create channel
      • Update channel
      • Delete channel
    • API Keys
      • List integration API keys
      • Create integration API key
      • Delete integration API key
      • Update integration API key
  1. User Field History

Get user field histories for a specific user

GET
/v1/communities/{communityId}/users/{userId}/user-field-histories

What this endpoint does#

Returns the newest field mutations for one member across every field in the community. Use it when you already have that member's Mongo ObjectId.
It does not write values. For one field across everyone, use the field-scoped URL.
INFO
Workflow
Authenticate → POST /v1/users/info for the ObjectId if you only have email → GET /v1/communities/{communityId}/users/{userId}/user-field-histories?page=1&limit=5.

Quick start#

Authentication and permission#

Send Authorization: Bearer <COMMUNITY_API_KEY> with userFields.

Complete examples#

Known member ObjectId (200). Codex returned USER_FIELD_HISTORIES_LISTED and Read user field histories for specific user api success. An empty data array is still 200 when that member has no history rows in this window.

Success and readback#

HTTP 200. meta.code is USER_FIELD_HISTORIES_LISTED. Rows include fieldName, action, value, storedValue, and timestamps.
CHECK
Readback
Empty data means no history for this user, not that the user is missing. Confirm the member with POST /v1/users/info.

Errors and recovery#

StatusWhenRecovery
403 API_KEY_COMMUNITY_MISMATCHWrong communityUse the key's community ObjectId.
401Missing or invalid keyReplace the key.
404Unknown userResolve with POST /v1/users/info first.

Retry safety#

TIP
Exact retry
Read-only. Retry timeouts with bounded backoff.

Gotchas#

Live on https://api.returning.ai as of 2026-08-19. Do not document 503 USER_FIELD_HISTORY_READ_NOT_READY as current unless a later probe sees it.

Next steps#

List one user and one field
Narrow further when you already know the field name or id.

Request

Path Params

Query Params

Responses

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

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://adss-application.returning.ai/v1/communities/507f1f77bcf86cd799439011/users/507f1f77bcf86cd799439012/user-field-histories?page=1&limit=10'
Response Response Example
200 - Success
{
    "meta": {
        "status": "success",
        "statusCode": 200,
        "total": 15,
        "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"
            },
            "value": 500,
            "action": "overwrite",
            "createdAt": "2025-06-24T06:43:01.078Z"
        },
        {
            "_id": "685957701ff244c62bd2e5b5",
            "field": {
                "_id": "6857de260f3c24d98fd7ca90",
                "field": "coins",
                "name": "Community Coins",
                "type": "number",
                "isCustom": true,
                "createdAt": "2025-06-20T11:20:45.000Z",
                "updatedAt": "2025-06-20T11:20:45.000Z"
            },
            "value": 100,
            "action": "increase",
            "createdAt": "2025-06-23T13:30:15.123Z"
        }
    ]
}
Modified at 2026-08-18 17:21:05
Previous
Get user field histories for a specific field
Next
Get user field histories of specific user field and user
Built with