Get user
Deprecated
GET
https://sgtr-api.returning.ai/v1/users/{userId}
Users
What this endpoint does
GET /v1/users/{userId}. That route is not mounted on the current public gateway https://api.returning.ai.POST /v1/users/info with an email or numeric platform id.INFO
POST /v1/users/info with { "idOrEmail": "<email-or-numeric-id>" } → read data._id and data.userId.Quick start
Authentication and permission
| Failure | Observed result | Recovery |
|---|---|---|
Missing or invalid Authorization | 401 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 token | 404 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
404 example is the current authenticated response for ObjectId, email, numeric id, and username.POST /v1/users/info body. Treat names as synthetic.Success and readback
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
| Status | When | Recovery |
|---|---|---|
404 Route not found error. | Authenticated GET /v1/users/{userId} for ObjectId, email, numeric id, or username | Stop. Call POST /v1/users/info. |
401 API request rejected error. | Missing or invalid Bearer token | Add a valid key, then use the POST replacement rather than retrying this GET. |
Retry safety
TIP
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
_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.400 Identifier is required. Use idOrEmail or identifier.GET /v1/communities/{communityId}/users/{userId} is a different operation.Next steps
Request
Path Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://sgtr-api.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:14:55