1. Application API
Returning.AI copy
  • 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 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
        • User Fields
          • Get All User Fields
          • Get Specific User Field
          • Create Custom User Field
          • Update Custom User Field
          • Delete Custom User Field
      • Integration API
        • Analysis API
          • Create Analysis
          • Get Analysis
          • Update Analysis
          • Delete Analysis
          • List Analyses
          • Append Drawings
        • Users
          • Get Users with Filters
          • Create New User
          • Get User Data
          • Manage User Account
          • Get User Gamification Stats
          • Bulk Import
          • Bulk Update
          • Premium Currency Bulk Update
          • Get All Bulk Update
          • Check Bulk Update Status
          • Check Bulk Update Details
          • Get all mini game logs by user email
          • Get user's current Mini Games and Streak stats
        • Messages
          • Get Messages
          • Send Message
          • Reply Message
          • React Message
          • Upload Image
        • Channels
          • Get Channels List
        • Xp Settings
          • Get Tier Info
        • Gamifications
          • Get User Gamification History
          • Get User Gamification Logs
        • Redemption Transactions
          • 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
        • Streak Logs
          • Get Streak Logs
    • 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
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
    • Schemas
      • ValidationError
      • NotFoundError
      • InternalServerError
      • NotImplementedError
      • CreateUserFieldHistoryResponse
      • CreateUserFieldHistorySuccessResponse
      • UserFieldHistoryItem
      • GetUserFieldHistoriesResponse
      • UserFieldHistoriesValidationError
      • UserFieldHistoriesMetaWithValidation
      • UserFieldHistoriesMetaWithPagination
      • GetUserFieldHistoriesSuccessResponse
      • CreateUserFieldResponse
      • CreateUserFieldSuccessResponse
      • DeleteUserFieldResponse
      • DeleteUserFieldSuccessResponse
      • UserFieldCreator
      • GetUserFieldResponse
      • GetUserFieldSuccessResponse
      • ValidationErrorItem
      • GetUserFieldsMetaResponse
      • CreatorInfo
      • UserFieldResponse
      • GetUserFieldsSuccessResponse
      • UpdateUserFieldResponse
      • UpdateUserFieldPayload
      • UpdateUserFieldSuccessResponse
      • MetaResponse
      • GetUserResponse
      • GetUserSuccessResponse
    • Outgoing webhooks
      • Purchased store item
      • New message posted to channel
      • User visits server
      • User join server
      • ErrorResponse
    • Analysis
      • UpdateAnalysisRequest
      • AppendDrawingsRequest
      • CreateAnalysisResponse
      • GetAnalysisResponse
      • UpdateAnalysisResponse
      • AppendDrawingsResponse
      • AnalysisMetadata
      • Expiry
      • Levels
      • LevelEntry
      • Drawing
      • HorizontalLineDrawing
      • LineDrawing
      • RectangleDrawing
      • ParallelDrawing
      • FibonacciRetracementDrawing
      • Coordinate
      • DrawingStyle
      • AnalysisDetail
      • AnalysisSummary
      • CreateAnalysisRequest
      • ListAnalysesResponse
  1. Application API

User Fields API

The User Fields API provides access to two types of user data fields: Default Fields and Custom Fields. This API enables developers to retrieve user information, track historical data changes, and create custom data points for enhanced user profiling and analytics.

Field types#

Default Fields
Pre-defined system fields containing core user information. These fields are automatically maintained by the platform.
Custom Fields
User-defined fields that can be created, modified, and populated via API. These fields allow for flexible data storage tailored to specific business needs.

Authorization#

All user fields API endpoints require authentication using an Bearer token in the request header.
Found in the platform under community settings > API keys.
Permission: User Fields

Community ID#

All user fields API endpoints require Community ID in the URL path.
Found in the platform under community settings > Appearance.

User ID#

For endpoints that require the user's id, use this endpoint: Get User Data and use the _id returned in the response.
Modified at 2026-03-24 09:39:51
Previous
Create user field history for specific user
Next
Get All User Fields
Built with