1. User Data
Returning.AI-dev-wip
  • Getting Started
  • Authentication
    • Secure Auth
      GET
    • register
      POST
    • verify email
      POST
    • login
      POST
  • Users
    • Get user
      GET
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data
      POST
    • Manage User Account
      POST
    • Get User Gamification Stats
      POST
    • Upload User Avatar
      POST
  • Roles & Permissions
    • role list of server
      GET
    • create new role
      POST
    • update role
      PUT
    • delete role
      DELETE
    • get role list of user on a server
      GET
    • add role to a user on a server
      POST
    • remove role from a user on a server
      POST
  • Servers
    • create new server
    • get my servers
    • update server
  • Channels
    • channel list of server
    • get channels list
    • create new channel
    • update channel
    • delete channel
    • Get Channels List
  • Messaging
    • Get Messages
    • Send Message
    • Reply Message
    • React Message
    • Upload Image
  • User Data
    • Get All User Fields
      GET
    • Get Specific User Field
      GET
    • Create Custom User Field
      POST
    • Update Custom User Field
      PUT
    • Delete Custom User Field
      DELETE
    • 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
  • Gamification
    • get badges list
    • create new badge
    • update badge
    • award badge to user
    • delete badge
    • remove badge from user
    • Get Tier Info
    • Get User Gamification History
    • Get User Gamification Logs
  • Streaks & Mini Games
    • Get Streak Logs
    • Get all mini game logs by user email
    • Get user's current Mini Games and Streak stats
    • Update user wheel info (spins and/or streaks) by email
  • Rewards & Redemptions
    • Update redemption transaction status
    • Get all redemption transactions by user email
    • Get All Redemption Statuses
    • Get Redemption Status by ID
    • Create Redemption Status
    • Get all redemption transactions by Community
    • Get Redemption Transaction History
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • List Analyses
    • Append Drawings
    • Delete Analysis
  • Bulk Operations
    • Check Bulk Update Details
    • Check Bulk Update Status
    • Premium Currency Bulk Update
    • Get All Bulk Update
    • Bulk Update
    • Bulk Import
  • Application API
    • Community Users
      • Get community users
      • Get user
  • Integration API
    • Community Analytics
      • Get Loyalty Overview
    • Streaks
      • Update Streak Settings
      • Get All Streaks
      • Create Streak
      • Update Streak
      • Delete Streak
  • Channels
    • Iframe
  • Widgets
    • Authenticated Widgets
    • Public widgets
  • 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
  • Features
  1. User Data

Get All User Fields

GET
/apis/v1/communities/{communityId}/user-fields
This endpoint retrieves all user fields associated with a specific community.

Authorization#

Bearer token Required
Found in the platform under community settings > API keys.
Permission: User Fields

Community ID#

Community ID is needed in the path.
Found in the platform under community settings > Appearance.

Custom fields#

To retrive custom fields, include "isCustom": true in the query parems.

Request

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://sgtr-rai-api.returning.ai/api/v1/apis/v1/communities//user-fields?isCustom'

Responses

🟢200OK
application/json
User fields retrieved successfully
Body

Example
{
    "meta": {
        "status": "success",
        "statusCode": 200,
        "total": 11
    },
    "message": "Get user fields success.",
    "data": [
        {
            "_id": "68ba4a4d9f71aa6",
            "name": "Account Manager",
            "field": "accountManager",
            "type": "multi_line_text",
            "creator": {
                "_id": "6617850c1e6b74e",
                "id": 1243,
                "avatar": "https://chartsnapshot-genesiv.s3.amazonaws.com/cbbd940c0b437cf3406.jpeg",
                "displayName": "John Doe",
                "username": "johndoe"
            },
            "isCustom": true,
            "createdAt": "2025-09-05T02:26:23.561Z",
            "updatedAt": "2025-09-05T02:26:23.561Z"
        },
        ...
        {
            "_id": "68ba411f71a0b",
            "name": "revenue",
            "field": "revenue",
            "type": "numerical",
            "creator": {
                "_id": "6617850c1e6b74e",
                "id": 1243,
                "avatar": "https://chartsnapshot-genesiv.s3.amazonaws.com/cbbd940c0b437cf3406.jpeg",
                "displayName": "John Doe",
                "username": "johndoe"
            },
            "isCustom": true,
            "createdAt": "2025-09-05T02:24:57.799Z",
            "updatedAt": "2025-09-05T02:24:57.799Z"
        }
    ]
}
🟠400Bad Request
🟠404Record Not Found
🟠401Unauthorized
🔴500Server Error
Modified at 2026-04-09 08:32:53
Previous
Upload Image
Next
Get Specific User Field