Returning.AI
  1. Users
Returning.AI
  • Returning.AI
    • Auth
      • register
      • verify email
      • login
      • secure auth
    • 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
        • manage user
        • user data
        • gamification stats
        • user bulk update
        • user bulk import
      • Messages
        • Send Message
        • Reply Message
        • React Message
      • Channels
        • Get Channels List
      • User Field Histories
        • Create user field history
        • Get user field histories
      • User Fields
        • Create user field
        • Get all user fields for a community
        • Delete user field
        • Update user field
        • Get specific user field
      • Users
        • Get user
    • Application
      • Users
        • Get user
          GET
      • Community Users
        • Get community users
        • Get community user
      • User Fields
        • Get all user fields for a community
        • Get specific user field
        • Create user field
        • Update user field
        • Delete user field
      • 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. Users

Get user

GET
/apis/v1/users/{userId}
Users
Retrieve user information by user ID with optional field selection.
Security Requirements:
Bearer token authentication required
Only application members can access this endpoint
User must have APPLICATION_MEMBER permission
User can only get their own information unless using community-based access

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
userId
string <objectId>
required
The ID of the user to retrieve
Example:
61100af5c548eb5c7ebc7819
Query Params
_id
boolean 
optional
Include _id field in response
Example:
true
id
boolean 
optional
Include id field in response
Example:
true
avatar
boolean 
optional
Include avatar field in response
Example:
true
displayName
boolean 
optional
Include displayName field in response
Example:
true
username
boolean 
optional
Include username field in response
Example:
true
firstName
boolean 
optional
Include firstName field in response
Example:
true
lastName
boolean 
optional
Include lastName field in response
Example:
true
email
boolean 
optional
Include email field in response
Example:
true
isOnline
boolean 
optional
Include isOnline field in response
Example:
true
lastLogin
boolean 
optional
Include lastLogin field in response
Example:
true

Request 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/users/'

Responses

🟢200OK
application/json
Get user successful
Body
meta
object 
optional
status
string 
optional
Response status
statusCode
number 
optional
HTTP status code
message
string 
optional
Success message for the operation
data
object 
optional
_id
string 
optional
User ID
id
number 
optional
User ID as number
avatar
string  | null 
optional
User avatar URL
displayName
string 
optional
User display name
username
string 
optional
User username
firstName
string 
optional
User first name
lastName
string 
optional
User last name
email
string 
optional
User email address
isOnline
boolean 
optional
User online status
lastLogin
string <date-time>
optional
User last login date
Example
{
    "meta": {
        "status": "success",
        "statusCode": 200
    },
    "message": "Get user success.",
    "data": {
        "_id": "61100af5c548eb5c7ebc7819",
        "id": 123456789,
        "avatar": "https://returning-ai.com/avatar.png",
        "displayName": "Admin",
        "username": "admin",
        "firstName": "John",
        "lastName": "Doe",
        "email": "admin@example.com",
        "isOnline": true,
        "lastLogin": "2023-12-01T10:30:00Z"
    }
}
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Modified at 2025-06-24 08:36:32
Previous
Get user
Next
Get community users