Get user - Returning.AI

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

userId

string <objectId>

required

The ID of the user to retrieve

Example:

61100af5c548eb5c7ebc7819

Query Params

_id

boolean

optional

Include _id field in response

Example:

true

avatar

boolean

optional

Include avatar field in response

Example:

true

displayName

boolean

optional

Include displayName field in response

Example:

true

username

boolean

optional

Include username field in response

Example:

true

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Get user successful

Body

meta

object

optional

status

string

optional

Response status

statusCode

number

optional

HTTP status code

message

string

optional

Success message for the operation

data

object

optional

_id

string

optional

User ID

id

number

optional

User ID as number

avatar

string | null

optional

User avatar URL

displayName

string

optional

User display name

username

string

optional

User username

Example

{
    "meta": {
        "status": "success",
        "statusCode": 200
    },
    "message": "Get user success.",
    "data": {
        "_id": "61100af5c548eb5c7ebc7819",
        "id": 123456789,
        "avatar": "https://returning-ai.com/avatar.png",
        "displayName": "Admin",
        "username": "admin"
    }
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error