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": "42"
}

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

Responses

🟢200Success

application/json

Body

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-08-27 07:37:12

Create New User

Get Users with Filters

Get User Data

Authorization#

Request

Request Code Samples

Responses

Authorization