Returning.AI
  1. User Fields
Returning.AI
  • Returning.AI
    • APIs
      • Authentication
      • System API
        • Auth
          • Secure Auth
          • register
          • verify email
          • login
        • Server
          • create new server
          • get my servers
          • update server
          • channel list of server
        • Channel
          • get channels list
          • create new channel
          • update channel
          • delete channel
        • Role
          • role list of server
          • create new role
          • update role
          • delete role
          • get role list of user on a server
          • add role to a user on a server
          • remove role from a user on a server
        • Badge
          • get badges list
          • create new badge
          • update badge
          • delete badge
          • award badge to user
          • remove badge from user
      • Application API
        • Community Users
          • Get community users
          • Get user
        • User Fields
          • 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
        • 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
        • Integration Api Key
          • Integration Api Key Info
          • Get Integration Api Key
          • Post Integration Api Key
          • Delete Integration Api Key
          • Update Integration Api Key
          • Login API
      • Integration API
        • Users
          • Get Users with Filters
          • Create New User
          • Get User Data
          • Manage User Account
          • Get User Gamification History
          • Get User Gamification Stats
          • Bulk Import
          • Bulk Update
          • Get All Bulk Update
          • Check Bulk Update Status
          • Check Bulk Update Details
        • Messages
          • Get Messages
          • Send Message
          • Reply Message
          • React Message
        • Channels
          • Get Channels List
        • Xp Settings
          • Get Tier Info
      • User API
        • API key
          • Update User Api Key
          • api key info
          • Delete Endpoint
          • Get User Api Key
          • Post User Api Key
        • Messages
          • Send Message
          • Reply Message
          • React Message
    • Channels
      • Iframe
    • 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
    • Widgets
      • Authenticated Widgets
      • Public widgets
    • Features
  1. User Fields

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

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' \
--header 'Authorization: Bearer <token>'

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 2025-09-17 09:10:45
Previous
User Fields
Next
Get Specific User Field