Get User Data

POST

/apis/v1/users/info

This endpoints returns all user fields (Default and Custom) for a single user.

Authorization

Bearer token Required

Found in the platform under community settings > API keys.
Permission: Get User Data

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Example

{
    "idOrEmail": "johndoe@gmail.com"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://integration.returning.ai/apis/v1/users/info' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "idOrEmail": "johndoe@gmail.com"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": "success",
    "data": {
        "_id": "66f178cs5df0d84eb50c1e6b",
        "userId": "1243",
        "username": "johndoe",
        "xp": 15551,
        "coins": 20905,
        "roles": [
            "@all",
            "@Gold"
        ],
        "highestRole": "@Gold",
        "firstName": "John",
        "lastName": "Doe",
        "xpEarnedToday": 30,
        "coinsEarnedToday": 30,
        "language": "English",
        "totalMessages": 84,
        "totalReactions": 42,
        "visitCount": 4418,
        "replySent": 42,
        "timeSpent": 660500,
        "loginStreak": 89,
        "customFields": {},
        "tags": []
    }
}

🟠401Invalid token

🟠401Insufficient permission

🟠404Record Not Found

Modified at 2025-09-05 08:19:55

Create New User

Manage User Account

Get User Data

Authorization#

Request

Request Code Samples

Responses

Authorization