Get community user

Retrieve user information by user ID within a community context with optional field selection.

Security Requirements:

Bearer token authentication required

User must have COMMUNITY_MEMBER or COMMUNITY_OWNER or COMMUNITY_ADMIN permission for the specified community

User must be a community member, owner, or administrator to access other users' information

Community members can access information of other community members but some fields are protected

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

communityId

string <objectId>

required

The ID of the community

Example:

61100af5c548eb5c7ebc7819

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

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

firstName

boolean

optional

Include firstName field in response

Example:

true

lastName

boolean

optional

Include lastName field in response

Example:

true

boolean

optional

Include email field in response

Example:

true

isOnline

boolean

optional

Include isOnline field in response

Example:

true

lastLogin

boolean

optional

Include lastLogin field in response

Example:

true

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

number

optional

User ID as number

avatar

string | null

optional

User avatar URL

displayName

string

optional

User display name

username

string

optional

User username

firstName

string

optional

User first name

lastName

string

optional

User last name

string

optional

User email address

isOnline

boolean

optional

User online status

lastLogin

string <date-time>

optional

User last login date

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",
        "firstName": "John",
        "lastName": "Doe",
        "email": "admin@example.com",
        "isOnline": true,
        "lastLogin": "2023-12-01T10:30:00Z"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses