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
          POST
        • manage user
          POST
        • user data
          POST
        • gamification stats
          GET
        • user bulk update
          POST
      • Messages
        • Send Message
        • Reply Message
        • React Message
      • Channels
        • Get Channels List
  1. users

user data

Developing
POST
/apis/v1/users/info

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
idOrEmail
string 
required
Example
{
    "idOrEmail": ""
}

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 POST 'https://integration.returning.ai/apis/v1/users/info' \
--header 'Content-Type: application/json' \
--data-raw '{
    "idOrEmail": ""
}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{
    "status": "success",
    "data": {
        "userId": "123",
        "xp": 123,
        "coins": 123,
        "roles": [
            "@all"
        ],
        "highestRole": "@all",
        "firstName": "---",
        "lastName": "---",
        "xpEarnedToday": 0,
        "coinsEarnedToday": 0,
        "language": "English",
        "totalMessages": 0,
        "totalReactions": 0,
        "visitCount": 0,
        "replySent": 0,
        "timeSpent": 0,
        "loginStreak": 0,
        "customFields": {}
    }
}
Modified at 2025-06-09 01:55:19
Previous
manage user
Next
gamification stats