Returning.AI
  1. User Fields
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
        • Get specific user field
          GET
        • Create user field
          POST
        • Update user field
          PUT
        • Delete user field
          DELETE
      • User Field Histories
        • Get all user field histories in a community
        • Get user field histories for a specific field
        • Get user field histories for a specific user
        • Get user field histories of specific user field and user
        • Create user field history for specific user
  1. User Fields

Get all user fields for a community

GET
/apis/v1/communities/{communityId}/user-fields
Retrieves all user fields associated with a specific community.
Security Requirements:
Bearer token authentication required
Only community members can access this endpoint
User must have COMMUNITY_MEMBER permission 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//user-fields?isCustom'

Responses

🟢200OK
application/json
User fields retrieved successfully
Body

Example
{
    "meta": {
        "status": "success",
        "statusCode": 200,
        "totalItemsCount": 1
    },
    "message": "Get user fields success.",
    "data": [
        {
            "_id": "6857de260f3c24d98fd7ca85",
            "field": "total",
            "name": "Total",
            "type": "numerical",
            "creator": {
                "_id": "61100af5c548eb5c7ebc7819",
                "id": 1,
                "avatar": "https://returning-ai.com/avatar.png",
                "displayName": "Admin",
                "username": "admin"
            },
            "isCustom": true,
            "createdAt": "2025-06-22T11:28:50.301Z",
            "updatedAt": "2025-06-22T11:28:50.301Z"
        }
    ]
}
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Modified at 2025-08-28 10:34:12
Previous
Get user
Next
Get specific user field