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 field

GET
/v1/communities/{communityId}/user-fields/{fieldIdOrName}/histories

What this endpoint does#

Returns the newest mutations for one user-field definition across every member in the community. Use it after you already know the field id or field name.
It does not write values. Community-wide history is the unscoped URL. One user plus one field is the combined URL.
INFO
Workflow
Authenticate → list definitions → GET /v1/communities/{communityId}/user-fields/{fieldIdOrName}/histories?page=1&limit=5 → paginate while meta.hasNext is true.

Quick start#

fieldIdOrName can be the field Mongo ObjectId or its name. On 2026-08-19 Codex, both the name and the id returned 200.

Authentication and permission#

Send Authorization: Bearer <COMMUNITY_API_KEY> with userFields. Wrong community ObjectId returns 403 API_KEY_COMMUNITY_MISMATCH.

Complete examples#

By name or id (200). page=1&limit=5 returned USER_FIELD_HISTORIES_LISTED and Read user field histories for specific user field api success.
Treat field names and values as synthetic.

Success and readback#

HTTP 200. meta.code is USER_FIELD_HISTORIES_LISTED. data is an array of history rows with userObjectID, fieldName, value, storedValue, action, and timestamps.
CHECK
Readback
Match fieldName / fieldID to the definition you queried. Empty data means no mutations for that field in this window.

Errors and recovery#

StatusWhenRecovery
403 API_KEY_COMMUNITY_MISMATCHWrong communityUse the key's community ObjectId.
401Missing or invalid keyReplace the key.
404Unknown fieldList definitions first.

Retry safety#

TIP
Exact retry
Read-only. Retry timeouts with bounded backoff. Do not retry 403 without changing communityId.

Gotchas#

Canonical history reads are live on https://api.returning.ai as of 2026-08-19. Older 503 USER_FIELD_HISTORY_READ_NOT_READY notes are stale for this gateway.

Next steps#

Update A User Field Value
Write a new value, then re-read this list.

Request

Path Params

Query Params

Responses

🟢200OK
application/json
Get user field histories for specific field 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/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-08-18 17:20:53
Previous
Get all user field histories in a community
Next
Get user field histories for a specific user
Built with