1. Users
Returning.AI
  • Getting Started
  • Users
    • User directory and provisioning
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data
      POST
    • Manage User Account
      POST
    • Get User Milestones
      POST
    • Update User Data, Identifier, And Roles
      POST
    • Update User XP and Currency
      POST
  • Messaging
    • Agent messaging workflow
    • Get Messages
      GET
    • Send Message
      POST
    • Reply Message
      POST
    • React Message
      POST
    • Upload message images
      POST
  • Gamification
    • Leaderboards
      • Leaderboards
      • List leaderboards with pagination
      • Create a new leaderboard
      • Update an existing leaderboard
      • Get a single leaderboard by ID
      • Delete a leaderboard
    • Streaks & Mini Games
      • Mini-game State and History
      • List user streak logs
      • List mini-game logs by user email
      • Get current mini-game and streak state
      • Update user spin-wheel information
    • Referral
      • Referral Program Integration
      • Get referral programs
      • Get user's referral summary
    • Rolling Data
      • Get Daily Calculation Data
      • Get Rolling Calculation Data
    • Match Predictions
    • Get tier configuration
      GET
    • Get daily user XP and coin changes
      POST
    • Search user gamification logs
      POST
    • Get user activity stats
      POST
  • Rewards & Redemptions
    • Store catalog to redemptions
    • Update redemption order status or refund
    • List redemption orders by user email
    • List redemption statuses
    • Get redemption status by ID
    • List redemption orders by community
    • Create redemption order status
    • Get redemption order status history
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk user updates
    • List bulk update jobs
    • Get bulk update job status
    • Get bulk update job details
    • Bulk update users from CSV
    • Bulk update premium currency from CSV
  • Channels
    • Iframe
    • List integration channels
  • Events
    • Outgoing webhooks
      • Encryption
      • User Joins Server
      • User Visits server
      • New Message Posted Anywhere
      • New Message Posted To channel
      • Purchased Store Item
    • Incoming webhooks
      • API Keys & Encryption
      • Send message into channels
      • Update Custom User Fields
      • Update In-game currency
  • Widgets
    • Authenticated Widgets
    • Public widgets
    • Channels
    • Leaderboard
    • Milestone
    • Socials
    • Store
  • Community Analytics
    • Get Loyalty Overview
    • Get Phone Verification Contacts
  • Store
    • Store catalog
    • Purchase History
      • Update redemption instructions or voucher details
    • Categories
      • List Store categories
      • Create Store category
      • Get Store category by ID
      • Update Store category
      • Delete Store category
    • Products
      • List products
      • Update products in bulk
      • Create products in bulk
      • Create product with vouchers
      • Read product
      • Update product and append vouchers
      • Delete product
    • Redemption-transaction
      • Get redemption transaction detail
    • Get Store configuration
    • Update Store configuration
  • Community
    • Community directory and appearance
    • Appearance
      • Update community theme colors
      • Update community bot profile
      • Update community URL metadata
      • Update community name and URL
    • Community Users
      • Get community users
      • Get user
    • Create community
  • API Keys
    • API key lifecycle
    • Community API Keys
      • Create API key
      • Read API keys
      • Delete API key
      • Update API key
    • User API Keys
      • List user API keys
      • Create user API key
      • Update user API key
      • Delete user API key
      • Get current API key information
  • User Fields
    • User field definitions and history
    • User Field History
      • 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
      • Update A User Field Value
      • Deprecated Field-First History Write
      • Deprecated Field-First History Read
    • Get A User Field Definition
    • Update A User Field Definition
    • Create A User Field Definition
    • Delete A User Field Definition
    • List User Field Definitions
  • Legacy
    • Servers
      • Create server
      • List servers
      • Update server metadata
    • Bulk Operations
      • Bulk import users from CSV
    • Authentication
      • Secure Auth
      • Register user with password
      • Verify user email
      • Log in user with password
    • Badges
      • List badges
      • Create badge
      • Update badge
      • Delete badge
      • Remove badge from user
      • Award badge to user
    • Messaging
    • Roles & Permissions
      • List server roles
      • Create role
      • Update role
      • Delete role
      • List user roles
      • Add role to user
      • Remove role from user
    • Users
      • Get user
        GET
      • Upload user avatar
        POST
    • Channels
      • Create channel
      • Update channel
      • Delete channel
    • API Keys
      • List integration API keys
      • Create integration API key
      • Delete integration API key
      • Update integration API key
  1. Users

Get user

Deprecated
GET
/v1/users/{userId}

What this endpoint does#

This page documents GET /v1/users/{userId}. That route is not mounted on the current public gateway https://api.returning.ai.
Do not use it to look up a user. Use POST /v1/users/info with an email or numeric platform id.
INFO
Replacement
Authenticate with a community API key that has Get User Data → POST /v1/users/info with { "idOrEmail": "<email-or-numeric-id>" } → read data._id and data.userId.

Quick start#

Do not call this GET. This is the request the public gateway currently rejects:
Use this instead:

Authentication and permission#

A Bearer token is still checked before the missing route is reported:
FailureObserved resultRecovery
Missing or invalid Authorization401 API request rejected error. with detail: A valid bearer token or API key is required for this endpoint.Add a valid community API key. Then stop; the GET still has no route.
Valid token404 Route not found error. detail: Cannot GET /apis/v1/users/{userId}Switch to POST /v1/users/info.
POST /v1/users/info requires the getUserData permission. A valid key without that permission returns 403.

Complete examples#

There is no success example for this GET. The structured 404 example is the current authenticated response for ObjectId, email, numeric id, and username.
The replacement success example in Next steps is a synthetic POST /v1/users/info body. Treat names as synthetic.

Success and readback#

This GET has no success response on https://api.returning.ai.
POST /v1/users/info returns HTTP 200 with status: success, code: USER_DATA_RETRIEVED, and message: User data retrieved successfully. That response is the readback. Save data._id and data.userId if another call follows.

Errors and recovery#

StatusWhenRecovery
404 Route not found error.Authenticated GET /v1/users/{userId} for ObjectId, email, numeric id, or usernameStop. Call POST /v1/users/info.
401 API request rejected error.Missing or invalid Bearer tokenAdd a valid key, then use the POST replacement rather than retrying this GET.

Retry safety#

TIP
Do not retry this GET
The authenticated 404 is the stable rejection. Retrying the same path will not create a route. After a transient transport failure you may retry once to confirm the 404, then migrate to POST /v1/users/info.
POST /v1/users/info is a read. Retry timeouts and 5xx on that POST with bounded exponential backoff. Do not retry its 400, 401, 403, or 404 without changing the body or credential.

Gotchas#

This slug is not a working GET-by-id
Mongo _id and username are not accepted as idOrEmail on POST /v1/users/info; they return 404 USER_NOT_FOUND.
{ "identifier": { "key": "id", "value": "<numeric-id>" } } currently also returns the user. Prefer idOrEmail.
An empty POST body returns 400 Identifier is required. Use idOrEmail or identifier.
Community-scoped GET /v1/communities/{communityId}/users/{userId} is a different operation.

Next steps#

Look up one user by email or numeric id
Use POST /v1/users/info. Send { "idOrEmail": "alex.admin@example.com" } or the numeric platform id as a string.

Request

Path Params

Header Params

Responses

🟠404Record Not Found
application/json
Authenticated request reached the public gateway and the route is not mounted.
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://adss-application.returning.ai/v1/users/61100af5c548eb5c7ebc7819' \
--header 'Authorization: Bearer <COMMUNITY_API_KEY>'
Response Response Example
{
  "meta": {
    "status": "error",
    "statusCode": 404
  },
  "message": "Route not found error.",
  "detail": "Cannot GET /apis/v1/users/{userId}",
  "solution": "Read error detail and try again."
}
Modified at 2026-08-18 16:15:20
Previous
Remove role from user
Next
Upload user avatar
Built with