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 ********************

Header Params

Authorization

string

optional

Example:

Bearer 60b3ac3ade848b39788384c82491bb908c9c0b05b37692327effe66a75ae3883

Body Params application/json

idOrEmail

string

required

Example

{
    "idOrEmail": "42"
}

Request 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 60b3ac3ade848b39788384c82491bb908c9c0b05b37692327effe66a75ae3883' \
--header 'Content-Type: application/json' \
--data-raw '{
    "idOrEmail": "42"
}'

Responses

🟢200Success

application/json

Body

status

string

required

data

object

required

userId

string

required

username

string

required

integer

required

coins

integer

required

roles

array[string]

required

highestRole

string

required

firstName

string

required

lastName

string

required

xpEarnedToday

integer

required

coinsEarnedToday

integer

required

language

string

required

totalMessages

integer

required

totalReactions

integer

required

visitCount

integer

required

replySent

integer

required

timeSpent

integer

required

loginStreak

integer

required

customFields

object

required

Example

{
    "status": "success",
    "data": {
        "userId": "123",
        "username": "___",
        "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-30 06:21:52

manage user

gamification stats