Get community users - Returning.AI

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

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Get community users successful

Body

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