Returning.AI
  1. User Field Histories
Returning.AI
  • Returning.AI
    • Auth
      • secure auth
      • register
      • verify email
      • login
    • 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
        • Get User Data
        • Get Users with Filters
        • Manage User account
        • Get User Gamification History
        • Get User Gamification Stats
        • Bulk Import
        • Bulk Update
      • Messages
        • Send Message
        • Reply Message
        • React Message
      • Channels
        • Get Channels List
      • User Api Key
        • Get User Api Key
        • Post User Api Key
        • Update User Api Key
        • Delete Endpoint
        • api key info
    • Application
      • Community Users
        • Get community users
        • Get 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 all user field histories in a community

GET
/apis/v1/communities/{communityId}/user-field-histories
Retrieve all user field history records within a community with full user and field details.
This endpoint returns comprehensive information including user profiles and field metadata for each history entry.
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
Community API key with userFields permission can also be used

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Query Params

Request Code 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/user-field-histories?page=1&limit=10'

Responses

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

Example
{
    "meta": {
        "status": "success",
        "statusCode": 200,
        "total": 125,
        "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"
            },
            "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",
            "field": {
                "_id": "6857de260f3c24d98fd7ca90",
                "field": "xp",
                "name": "Experience Points",
                "type": "number",
                "isCustom": true,
                "createdAt": "2025-06-20T11:20:45.000Z",
                "updatedAt": "2025-06-20T11:20:45.000Z"
            },
            "user": {
                "_id": "507f1f77bcf86cd799439013",
                "id": 12346,
                "avatar": null,
                "displayName": "Jane Smith",
                "username": "janesmith"
            },
            "value": 50,
            "action": "increase",
            "createdAt": "2025-06-23T13:30:15.123Z"
        }
    ]
}
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Modified at 2025-08-28 10:35:37
Previous
Delete user field
Next
Get user field histories for a specific field