Get user field histories for a specific field

Retrieve all user field history records for a specific field within a community.
This endpoint returns user details for each history entry but omits field information since the field 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}$

fieldIdOrName

string

required

The unique identifier or name of the user field

Example:

507f1f77bcf86cd799439013

Match pattern:

^[0-9a-fA-F]{24}$

Query Params

page

integer

required

Page number for pagination

>= 1

Example:

limit

integer

required

Number of items per page

>= 1<= 100

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Get user field histories for specific field 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

user

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": 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"
        }
    ]
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error