Returning.AI
  1. User Field Histories
Returning.AI
  • Returning.AI
    • Auth
      • register
      • verify email
      • login
      • secure auth
    • Server
      • create new server
      • get my servers
      • update server
      • role list of server
      • channel list of server
    • Role
      • create new role
      • update role
      • delete role
      • add role to a user on a server
      • remove role from a user on a server
      • get role list of user on a server
    • Channel
      • get channels list
      • create new channel
      • update channel
      • delete channel
    • Badge
      • get badges list
      • create new badge
      • update badge
      • delete badge
      • award badge to user
      • remove badge from user
    • Integration
      • users
        • create new user
        • manage user
        • user data
        • gamification stats
        • user bulk update
        • user bulk import
      • Messages
        • Send Message
        • Reply Message
        • React Message
      • Channels
        • Get Channels List
      • User Field Histories
        • Create user field history
        • Get user field histories
      • User Fields
        • Create user field
        • Get all user fields for a community
        • Delete user field
        • Update user field
        • Get specific user field
      • Users
        • Get user
    • Application
      • Users
        • Get user
      • Community Users
        • Get community users
        • Get community user
      • User Fields
        • Get all user fields for a community
        • Get specific user field
        • Create user field
        • Update user field
        • Delete user field
      • User Field Histories
        • 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
  1. User Field Histories

Get user field histories for a specific user

GET
/apis/v1/communities/{communityId}/users/{userId}/user-field-histories
User Field Histories
Retrieve all user field history records for a specific user within a community.
This endpoint returns field details for each history entry but omits user information since the user 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

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
communityId
string 
required
The unique identifier of the community
Example:
507f1f77bcf86cd799439011
Match pattern:
^[0-9a-fA-F]{24}$
userId
string 
required
The unique identifier of the user
Example:
507f1f77bcf86cd799439012
Match pattern:
^[0-9a-fA-F]{24}$
Query Params
page
integer 
required
Page number for pagination
>= 1
Example:
1
limit
integer 
required
Number of items per page
>= 1<= 100
Example:
10

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

Responses

🟢200OK
application/json
Get user field histories for specific user successful
Body
meta
object 
optional
status
string 
optional
statusCode
number 
optional
total
number 
optional
Total number of records
page
number 
optional
Current page number
limit
number 
optional
Number of items per page
message
string 
optional
Success message for the operation
data
array [object {5}] 
optional
_id
string 
optional
User field history unique identifier
field
object 
optional
value
optional
The field value of the change (can be any type)
action
enum<string> 
optional
Type of action performed on the field
Allowed values:
increasedecreaseoverwrite
createdAt
string <date-time>
optional
When this history entry was created
Example
{
    "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"
        }
    ]
}
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Modified at 2025-06-24 08:36:40
Previous
Get user field histories for a specific field
Next
Get user field histories of specific user field and user