Get community users

Retrieve a paginated list of users in a specific community with optional field selection.

Security Requirements:

Bearer token authentication required

Only community members, administrators, or owners can access this endpoint

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

Some properties are not available for all users, depending on the user's privacy settings

Some properties are not available for member permission level

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 to get users from

Example:

61100af5c548eb5c7ebc7819

Query Params

page

number

optional

Page number for pagination (default 1)

>= 1

Example:

limit

number

optional

Number of users per page (default 20, max 100)

>= 1<= 100

Example:

_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 community users successful

Body

meta

object

optional

status

string

optional

statusCode

number

optional

message

string

optional

Success message for the operation

data

array [object {10}]

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 timestamp

Example

{
    "meta": {
        "status": "success",
        "statusCode": 200
    },
    "message": "Get users 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"
        },
        {
            "_id": "61100af5c548eb5c7ebc781a",
            "id": 987654321,
            "avatar": null,
            "displayName": "User",
            "username": "user",
            "firstName": "Jane",
            "lastName": "Smith",
            "email": "user@example.com",
            "isOnline": false,
            "lastLogin": "2023-11-30T15:45:00Z"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses