1. User Field History
Returning.AI
  • Getting Started
  • Bulk Operations
    • Bulk user updates
    • List bulk update jobs
      GET
    • Get bulk update job status
      GET
    • Get bulk update job details
      GET
    • Bulk update users from CSV
      POST
    • Bulk update premium currency from CSV
      POST
  • Chart Analysis
    • Create Analysis
      POST
    • Get Analysis
      GET
    • Update Analysis
      PATCH
    • Delete Analysis
      DELETE
    • List Analyses
      GET
    • Append Drawings
      POST
  • Rewards & Redemptions
    • Redemption lifecycle
    • 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
    • List redemption orders by custom-field identifier
  • 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
    • Match Predictions
      • Create match prediction
      • List match predictions
      • Get match prediction
      • Patch match prediction
      • Publish match prediction
      • Settle match prediction
      • Get settlement results
      • Void match prediction
      • Bulk update match predictions
      • Get bulk job status
      • Get bulk job results
    • Loyalty Points
      • Create loyalty points export
      • Get loyalty points export status
      • Get loyalty points export download link
    • Quizzes
      • Create quiz
      • List quizzes
      • Get quiz
      • Update quiz
      • Delete quiz
      • Add quiz question
      • Update quiz question
      • Delete quiz question
    • Get tier configuration
    • Get daily user XP and coin changes
    • Search user gamification logs
    • Get user activity stats
  • Messaging
    • Agent messaging workflow
    • Get Messages
    • Send Message
    • Reply Message
    • React Message
    • Upload message images
  • Users
    • User directory and provisioning
    • Get Users with Filters
    • Create New User
    • Get User Data
    • Manage User Account
    • Get User Milestones
    • Update User Data, Identifier, And Roles
  • 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 journey
    • Store catalog
    • Purchase History
      • Archive or restore an order
      • 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
      • Create products in bulk
      • Create product with vouchers
      • Update products in bulk
      • 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
  • User Fields
    • User field definitions and history
    • User Field History
      • List Community User-Field History
        GET
      • List One Field Across Users
        GET
      • List One User Across Fields
        GET
      • List One User's One Field
        GET
      • Update A User Field Value
        POST
      • Deprecated Field-First History Write
        POST
      • Deprecated Field-First History Read
        GET
    • Create A User Field Definition
      POST
    • Get A User Field Definition
      GET
    • Update A User Field Definition
      PUT
    • Delete A User Field Definition
      DELETE
    • List User Field Definitions
      GET
  • 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
  • Legacy
    • Servers
      • Create server
      • List servers
      • Update server metadata
    • Bulk Operations
      • Bulk import users from CSV
    • Authentication
      • Register user with password
      • Verify user email
      • Log in user with password
      • Secure Auth
    • 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
  • Community Logs
    • Retrieve and export community logs
  1. User Field History

List One User Across Fields

GET
https://sgtr-api.returning.ai/v1/communities/{communityId}/users/{userId}/user-field-histories
User Fields/User Field History

What this endpoint does#

Returns the newest user-field mutations for one community member. Results are ordered newest first.

Cursor pagination#

Start the first page with cursor=start.
Each page contains at most 200 history records.
When data.pagination.hasNextPage is true, send data.nextCursor as the next request's cursor.
nextCursor is omitted when no later page exists.
Treat cursors as opaque values and do not decode or modify them.

Quick start#

Authentication#

Send a community API key with the userFields permission as Authorization: Bearer <apiKey>. The authenticated principal must be allowed to read the requested community.

Success response#

HTTP 200 returns { meta, message, data }. The nested data.pagination object contains total, currentPage, totalPages, hasNextPage, and hasPrevPage. The nested data.data array contains the history records.

Errors#

400 INVALID_PAGINATION — the cursor is empty, malformed, or cannot be decrypted.
401 AUTHENTICATION_REQUIRED — the bearer credential is missing or invalid.
403 API_KEY_PERMISSION_DENIED — the credential cannot read this community's history.
404 — a user or field selected by this endpoint does not exist.
500 USER_FIELD_OPERATION_FAILED — an unexpected read failure occurred.
503 USER_FIELD_HISTORY_READ_NOT_READY — history reads are not enabled for the deployment.

Retry safety#

This endpoint is read-only. Retry timeouts and unexpected server errors with bounded backoff. Restart from cursor=start if a saved cursor is rejected.

Related endpoints#

listCommunityUserFieldHistories — related history scope
listUserFieldHistoriesByField — related history scope
listUserFieldHistoriesByUserAndField — related history scope
Update a user-field value — writes a value that can appear in history

Request

Path Params

Query Params

Header Params

Responses

🟢200OK
application/json
Cursor-paginated user-field history was returned successfully.
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
🔴503Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://sgtr-api.returning.ai/v1/communities/6502c9e514a3e564c5c09c0a/users/member@example.com/user-field-histories?cursor=start' \
--header 'Authorization: Bearer XXXXXX'
Response Response Example
200 - Cursor Success Example
First cursor page with another page available.
{
  "meta": {
    "status": "success",
    "statusCode": 200,
    "code": "USER_FIELD_HISTORIES_LISTED",
    "scope": "user"
  },
  "message": "Read user field histories for specific user api success.",
  "data": {
    "pagination": {
      "total": 496805,
      "currentPage": 1,
      "totalPages": 2485,
      "hasNextPage": true,
      "hasPrevPage": false
    },
    "nextCursor": "U2FsdGVkX1/6+vdZcqFhnWfpnXZNtegH4eHRJKbWyyg=",
    "data": [
      {
        "_id": "66f000000000000000000020",
        "communityID": "6502c9e514a3e564c5c09c0a",
        "userID": "66f000000000000000000021",
        "userObjectID": "66f000000000000000000021",
        "userNumericID": 3247779,
        "fieldID": "66f000000000000000000010",
        "fieldName": "trading_volume",
        "fieldType": "numerical",
        "value": 10,
        "storedValue": 110,
        "action": "increase",
        "createdAt": "2026-09-18T10:30:00.000Z",
        "updatedAt": "2026-09-18T10:30:00.000Z"
      }
    ]
  }
}
Modified at 2026-09-18 05:32:12
Previous
List One Field Across Users
Next
List One User's One Field
Built with