Get user field histories for a specific field

What it is for: Get user field histories for a specific field. Use this to audit changes to broker-specific custom fields, reconcile historical values, and troubleshoot user-data syncs.

How to use it: Send a GET request to /v1/communities/{communityId}/user-fields/{fieldIdOrName}/histories. Authorization: Bearer <apiKey> or an admin bearer token, depending on the owning API surface. The key must be scoped to the community and have user-field access.

Successful response: HTTP 200. The body follows the endpoint schema; many integration endpoints wrap the useful payload under data with status and message.

Common error states:

400 invalid request body, query, ObjectId, pagination, file format, or missing required field.

401 missing, invalid, expired, or insufficient API key/token.

403 key is valid but cannot access this community/channel/user/resource, where supported by the service.

404 target resource, route, or community-scoped record was not found.

409 duplicate or conflicting state for create/update operations, where applicable.

500 unexpected Returning.AI service error.

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

Get user field histories for a specific field

Request

Responses